repo_name
stringlengths 1
52
| repo_creator
stringclasses 6
values | programming_language
stringclasses 4
values | code
stringlengths 0
9.68M
| num_lines
int64 1
234k
|
|---|---|---|---|---|
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using System.Linq;
using System.Net;
using Amazon.S3;
using Amazon.S3.Model;
using AmazonGameLiftPlugin.Core.BucketManagement;
using AmazonGameLiftPlugin.Core.BucketManagement.Models;
using AmazonGameLiftPlugin.Core.Shared;
using AmazonGameLiftPlugin.Core.Shared.S3Bucket;
using AmazonGameLiftPlugin.Core.Tests.Factories;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.BucketManagement
{
[TestFixture]
public class BucketStoreTests
{
private BucketStoreFactory Factory { get; set; }
[SetUp]
public void Init()
{
Factory = new BucketStoreFactory();
}
[Test]
public void CreateBucket_WhenCorrectBucketNameIsPassed_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(
x => x.PutBucket(It.IsAny<PutBucketRequest>()))
.Returns(new PutBucketResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
amazonS3WrapperMock.Setup(
x => x.PutBucketVersioning(It.IsAny<PutBucketVersioningRequest>()))
.Returns(new PutBucketVersioningResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
amazonS3WrapperMock.Setup(
x => x.PutBucketEncryption(It.IsAny<PutBucketEncryptionRequest>()))
.Returns(new PutBucketEncryptionResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
amazonS3WrapperMock.Setup(
x => x.GetACL(It.IsAny<GetACLRequest>()))
.Returns(new GetACLResponse()
{
AccessControlList = new S3AccessControlList(),
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
amazonS3WrapperMock.Setup(
x => x.PutACL(It.IsAny<PutACLRequest>()))
.Returns(new PutACLResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
amazonS3WrapperMock.Setup(
x => x.PutBucketLogging(It.IsAny<PutBucketLoggingRequest>()))
.Returns(new PutBucketLoggingResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-2";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = validRegion,
Region = validRegion
});
amazonS3WrapperMock.VerifyAll();
Assert.IsTrue(createBucketResponse.Success);
}
[Test]
public void CreateBucket_WhenEmptyBucketNameIsPassed_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-2";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = string.Empty,
Region = validRegion
});
Assert.IsFalse(createBucketResponse.Success);
Assert.IsNotEmpty(createBucketResponse.ErrorCode);
Assert.AreEqual(createBucketResponse.ErrorCode, ErrorCode.BucketNameIsWrong);
}
[Test]
public void CreateBucket_WhenAWSReturnsError_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(
x => x.PutBucket(It.IsAny<PutBucketRequest>()))
.Returns(new PutBucketResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.Unauthorized
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-2";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = $"non-empty-name{Guid.NewGuid()}",
Region = validRegion
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(createBucketResponse.Success);
Assert.AreEqual(createBucketResponse.ErrorCode, ErrorCode.AwsError);
}
[Test]
public void CreateBucket_WhenAWSSDKThrowsAmazonS3Exception_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
const string errorCodeFromAWS = "BucketAlreadyOwnedByYou";
const string errorMessageFromAWS = "NonEmptyMessage";
amazonS3WrapperMock.Setup(
x => x.PutBucket(It.IsAny<PutBucketRequest>()))
.Throws(new AmazonS3Exception(errorMessageFromAWS)
{
ErrorCode = errorCodeFromAWS
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-2";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = $"non-empty-name{Guid.NewGuid()}",
Region = validRegion
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(createBucketResponse.Success);
Assert.AreEqual(createBucketResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(createBucketResponse.ErrorMessage, errorMessageFromAWS);
}
[Test]
public void CreateBucket_WhenAWSSDKThrowsWebException_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
string exceptionMessage = "NonEmptyMessage";
amazonS3WrapperMock.Setup(
x => x.PutBucket(It.IsAny<PutBucketRequest>()))
.Throws(new WebException(exceptionMessage)).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-2";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = $"non-empty-name{Guid.NewGuid()}",
Region = validRegion
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(createBucketResponse.Success);
Assert.AreEqual(createBucketResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(createBucketResponse.ErrorMessage, exceptionMessage);
}
[Test]
public void CreateBucket_WhenAWSSDKThrowsArgumentNullException_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
string exceptionMessage = "Value cannot be null.";
amazonS3WrapperMock.Setup(
x => x.PutBucket(It.IsAny<PutBucketRequest>()))
.Throws(new ArgumentNullException()).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-2";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = $"non-empty-name{Guid.NewGuid()}",
Region = validRegion
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(createBucketResponse.Success);
Assert.AreEqual(createBucketResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(createBucketResponse.ErrorMessage, exceptionMessage);
}
[Test]
public void GetBucketsList_WhenBucketsExist_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.ListBuckets()).Returns(new ListBucketsResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Buckets = new System.Collections.Generic.List<S3Bucket>()
{
new S3Bucket()
{
BucketName = $"non-empty-name{Guid.NewGuid()}",
CreationDate = DateTime.Now
}
}
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse createBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest());
amazonS3WrapperMock.VerifyAll();
Assert.IsTrue(createBucketResponse.Success);
Assert.IsTrue(createBucketResponse.Buckets.Any());
}
[Test]
public void GetBucketsList_WhenAWSReturnsError_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.ListBuckets()).Returns(new ListBucketsResponse() { HttpStatusCode = System.Net.HttpStatusCode.Unauthorized }).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse getBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest());
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(getBucketResponse.Success);
}
[Test]
public void GetBucketsList_WhenAWSSDKThrowsAmazonS3Exception_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
string errorCodeFromAWS = "NonEmptyMessage";
amazonS3WrapperMock.Setup(x => x.ListBuckets())
.Throws(new AmazonS3Exception("NonEmptyMessage")
{
ErrorCode = errorCodeFromAWS
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse getBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest());
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(getBucketResponse.Success);
Assert.AreEqual(getBucketResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(getBucketResponse.ErrorMessage, errorCodeFromAWS);
}
[Test]
public void GetBucketsList_WhenAWSSDKThrowsArgumentNullException_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
string exceptionMessage = "Value cannot be null.";
amazonS3WrapperMock.Setup(x => x.ListBuckets())
.Throws(new ArgumentNullException()).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse getBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest());
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(getBucketResponse.Success);
Assert.AreEqual(getBucketResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(getBucketResponse.ErrorMessage, exceptionMessage);
}
[Test]
public void GetBucketsList_WhenAWSSDKThrowsWebException_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
string exceptionMessage = "NonEmptyMessage";
amazonS3WrapperMock.Setup(x => x.ListBuckets())
.Throws(new WebException(exceptionMessage)).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse getBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest());
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(getBucketResponse.Success);
Assert.AreEqual(getBucketResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(getBucketResponse.ErrorMessage, exceptionMessage);
}
[Test]
public void GetBucketsList_WhenRegionIsPassed_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.ListBuckets()).Returns(new ListBucketsResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Buckets = new System.Collections.Generic.List<S3Bucket>()
{
new S3Bucket()
{
BucketName = $"non-empty-name{Guid.NewGuid()}",
CreationDate = DateTime.Now
}
}
}).Verifiable();
amazonS3WrapperMock.Setup(x => x.GetBucketLocation(It.IsAny<GetBucketLocationRequest>())).Returns(new GetBucketLocationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Location = "us-west-1"
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse createBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest()
{
Region = "us-west-1"
});
amazonS3WrapperMock.VerifyAll();
Assert.IsTrue(createBucketResponse.Success);
Assert.IsTrue(createBucketResponse.Buckets.Any());
}
[Test]
public void GetBucketsList_WhenBucketsDoNotExist_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.ListBuckets()).Returns(new ListBucketsResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketsResponse createBucketResponse = bucketStore.GetBuckets(new GetBucketsRequest()
{
});
amazonS3WrapperMock.VerifyAll();
Assert.IsTrue(createBucketResponse.Success);
}
[Test]
public void CreateBucket_WhenBucketNameAlreadyExists_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
string bucketName = "existing-bucket";
amazonS3WrapperMock.Setup(
x => x.DoesBucketExist(bucketName)
).Returns(true);
IBucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
string validRegion = "us-west-1";
CreateBucketResponse createBucketResponse = bucketStore.CreateBucket(new CreateBucketRequest()
{
BucketName = bucketName,
Region = validRegion
});
Assert.IsFalse(createBucketResponse.Success);
Assert.IsNotEmpty(createBucketResponse.ErrorCode);
Assert.AreEqual(createBucketResponse.ErrorCode, ErrorCode.BucketNameAlreadyExists);
}
[Test]
public void PutLifecycleConfiguration_WhenBucketExists_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.GetLifecycleConfiguration(It.IsAny<string>()))
.Returns(new GetLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
})
.Verifiable();
amazonS3WrapperMock.Setup(x => x.PutLifecycleConfiguration(It.IsAny<Amazon.S3.Model.PutLifecycleConfigurationRequest>()))
.Returns(new Amazon.S3.Model.PutLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
}).Verifiable(); ;
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
Core.BucketManagement.Models.PutLifecycleConfigurationResponse putLifecycleConfigurationResponse = bucketStore.PutLifecycleConfiguration(new Core.BucketManagement.Models.PutLifecycleConfigurationRequest()
{
BucketName = "ValidBucketName",
BucketPolicy = BucketPolicy.SevenDaysLifecycle
});
amazonS3WrapperMock.VerifyAll();
Assert.IsTrue(putLifecycleConfigurationResponse.Success);
Assert.Null(putLifecycleConfigurationResponse.ErrorCode);
}
[Test]
public void PutLifecycleConfiguration_WhenAwsReturnsError_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.GetLifecycleConfiguration(It.IsAny<string>()))
.Returns(new GetLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
})
.Verifiable();
amazonS3WrapperMock.Setup(x => x.PutLifecycleConfiguration(It.IsAny<Amazon.S3.Model.PutLifecycleConfigurationRequest>()))
.Returns(new Amazon.S3.Model.PutLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.Unauthorized
}).Verifiable(); ;
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
Core.BucketManagement.Models.PutLifecycleConfigurationResponse putLifecycleConfigurationResponse = bucketStore.PutLifecycleConfiguration(new Core.BucketManagement.Models.PutLifecycleConfigurationRequest()
{
BucketName = "ValidBucketName",
BucketPolicy = BucketPolicy.SevenDaysLifecycle
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(putLifecycleConfigurationResponse.Success);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorCode, ErrorCode.AwsError);
}
[Test]
public void PutLifecycleConfiguration_WhenAWSSDKThrowsAmazonS3Exception_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.GetLifecycleConfiguration(It.IsAny<string>()))
.Returns(new GetLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
})
.Verifiable();
string errorCodeFromAWS = "NonEmptyMessage";
amazonS3WrapperMock.Setup(x => x.PutLifecycleConfiguration(It.IsAny<Amazon.S3.Model.PutLifecycleConfigurationRequest>()))
.Throws(new AmazonS3Exception("NonEmptyMessage")
{
ErrorCode = errorCodeFromAWS
}).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
Core.BucketManagement.Models.PutLifecycleConfigurationResponse putLifecycleConfigurationResponse = bucketStore.PutLifecycleConfiguration(new Core.BucketManagement.Models.PutLifecycleConfigurationRequest()
{
BucketName = "ValidBucketName",
BucketPolicy = BucketPolicy.SevenDaysLifecycle
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(putLifecycleConfigurationResponse.Success);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorMessage, errorCodeFromAWS);
}
[Test]
public void PutLifecycleConfiguration_WhenAWSSDKThrowsWebException_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.GetLifecycleConfiguration(It.IsAny<string>()))
.Returns(new GetLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
})
.Verifiable();
string exceptionMessage = "NonEmptyMessage";
amazonS3WrapperMock.Setup(x => x.PutLifecycleConfiguration(It.IsAny<Amazon.S3.Model.PutLifecycleConfigurationRequest>()))
.Throws(new WebException(exceptionMessage)).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
Core.BucketManagement.Models.PutLifecycleConfigurationResponse putLifecycleConfigurationResponse = bucketStore.PutLifecycleConfiguration(new Core.BucketManagement.Models.PutLifecycleConfigurationRequest()
{
BucketName = "ValidBucketName",
BucketPolicy = BucketPolicy.SevenDaysLifecycle
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(putLifecycleConfigurationResponse.Success);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorMessage, exceptionMessage);
}
[Test]
public void PutLifecycleConfiguration_WhenAWSSDKThrowsArgumentNullException_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
amazonS3WrapperMock.Setup(x => x.GetLifecycleConfiguration(It.IsAny<string>()))
.Returns(new GetLifecycleConfigurationResponse()
{
HttpStatusCode = System.Net.HttpStatusCode.OK
})
.Verifiable();
string exceptionMessage = "Value cannot be null.";
amazonS3WrapperMock.Setup(x => x.PutLifecycleConfiguration(It.IsAny<Amazon.S3.Model.PutLifecycleConfigurationRequest>()))
.Throws(new ArgumentNullException()).Verifiable();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
Core.BucketManagement.Models.PutLifecycleConfigurationResponse putLifecycleConfigurationResponse = bucketStore.PutLifecycleConfiguration(new Core.BucketManagement.Models.PutLifecycleConfigurationRequest()
{
BucketName = "ValidBucketName",
BucketPolicy = BucketPolicy.SevenDaysLifecycle
});
amazonS3WrapperMock.VerifyAll();
Assert.IsFalse(putLifecycleConfigurationResponse.Success);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorCode, ErrorCode.AwsError);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorMessage, exceptionMessage);
}
[Test]
public void PutLifecycleConfiguration_WhenInvalidBucketPolicyPassed_IsNotSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
int invalidBucketPolicy = -12;
Core.BucketManagement.Models.PutLifecycleConfigurationResponse putLifecycleConfigurationResponse = bucketStore.PutLifecycleConfiguration(new Core.BucketManagement.Models.PutLifecycleConfigurationRequest()
{
BucketName = "ValidBucketName",
BucketPolicy = (BucketPolicy)invalidBucketPolicy
}); ;
Assert.IsFalse(putLifecycleConfigurationResponse.Success);
Assert.NotNull(putLifecycleConfigurationResponse.ErrorCode);
Assert.AreEqual(putLifecycleConfigurationResponse.ErrorCode, ErrorCode.InvalidBucketPolicy);
}
[Test]
public void GetAvailableRegions_WhenRegionsReturned_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetAvailableRegionsResponse createBucketResponse = bucketStore.GetAvailableRegions(new GetAvailableRegionsRequest());
Assert.IsTrue(createBucketResponse.Success);
Assert.NotNull(createBucketResponse.Regions);
}
[Test]
public void GetBucketPolicies_WhenPoliciesReturned_IsSuccessful()
{
var amazonS3WrapperMock = new Mock<IAmazonS3Wrapper>();
BucketStore bucketStore = Factory.CreateBucketStore(amazonS3WrapperMock.Object);
GetBucketPoliciesResponse getBucketPoliciesResponse = bucketStore.GetBucketPolicies(new GetBucketPoliciesRequest());
Assert.IsTrue(getBucketPoliciesResponse.Success);
Assert.NotNull(getBucketPoliciesResponse.Policies);
}
}
}
| 610 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using System.IO;
using System.Linq;
using AmazonGameLiftPlugin.Core.CredentialManagement;
using AmazonGameLiftPlugin.Core.CredentialManagement.Models;
using AmazonGameLiftPlugin.Core.Shared;
using AmazonGameLiftPlugin.Core.Tests.Factories;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.CredentialManagement
{
[TestFixture]
public class CredentialsStoreTests
{
private string FilePath { get; set; }
private CredentialsStoreFactory Factory { get; set; }
[SetUp]
public void Init()
{
FilePath = Path.Combine(Directory.GetCurrentDirectory(), $"customCredentialsFile.ini");
Factory = new CredentialsStoreFactory(FilePath);
if (!File.Exists(FilePath))
{
FileStream filestream = File.Create(FilePath);
filestream.Close();
}
}
[TearDown]
public void Cleanup()
{
File.Delete(FilePath);
}
[Test]
public void SaveAwsCredentials_WhenCredentialsAreCorrect_IsSuccessful()
{
string profileName = $"NonEmptyProfileName-{Guid.NewGuid()}";
string accessKey = $"NonEmptyAccessKey-{Guid.NewGuid()}";
string secretKey = $"NonEmptySecretKey-{Guid.NewGuid()}";
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
SaveAwsCredentialsResponse response = credentialsStore.SaveAwsCredentials(new SaveAwsCredentialsRequest()
{
AccessKey = accessKey,
SecretKey = secretKey,
ProfileName = profileName
}); ;
Assert.IsTrue(response.Success);
Assert.IsNull(response.ErrorCode);
}
[Test]
public void SaveAwsCredentials_WhenAwsProfileAlreadyExists_IsNotSuccessful()
{
string profileName = $"NonEmptyProfileName-{Guid.NewGuid()}";
(string profileName, string accessKey, string secretKey) existingCredentials = EnsureValidCredentialsIsCreated(profileName: profileName);
string newAccessKey = $"NonEmptyAccessKey-{Guid.NewGuid()}";
string newSecretKey = $"NonEmptySecretKey-{Guid.NewGuid()}";
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
SaveAwsCredentialsResponse response = credentialsStore.SaveAwsCredentials(new SaveAwsCredentialsRequest()
{
AccessKey = newAccessKey,
SecretKey = newSecretKey,
ProfileName = profileName
}); ;
Assert.IsFalse(response.Success);
Assert.IsNotEmpty(response.ErrorCode);
Assert.AreSame(response.ErrorCode, ErrorCode.ProfileAlreadyExists);
}
[Test]
public void SaveAwsCredentials_WhenCredentialsAreEmpty_IsNotSuccessful()
{
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
SaveAwsCredentialsResponse response = credentialsStore.SaveAwsCredentials(new SaveAwsCredentialsRequest()
{
AccessKey = null,
SecretKey = null,
ProfileName = null
});
Assert.IsFalse(response.Success);
}
[Test]
public void RetriveAwsCredentials_WhenProfileExists_IsSuccessful()
{
string profileName = $"NonEmptyProfileName-{Guid.NewGuid()}";
(string profileName, string accessKey, string secretKey) existingCredentials = EnsureValidCredentialsIsCreated(profileName: profileName);
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
//Retrive
RetriveAwsCredentialsResponse credentials = credentialsStore.RetriveAwsCredentials(new RetriveAwsCredentialsRequest()
{
ProfileName = profileName
});
Assert.NotNull(credentials);
Assert.AreEqual(existingCredentials.accessKey, credentials.AccessKey);
Assert.AreEqual(existingCredentials.secretKey, credentials.SecretKey);
Assert.AreEqual(existingCredentials.profileName, profileName);
}
[Test]
public void RetriveAwsCredentials_WhenProfileDoesNotExist_IsNotSuccessful()
{
string profileName = $"NonEmptyProfileName-{Guid.NewGuid()}";
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
RetriveAwsCredentialsResponse retriveAwsCredentialsResponse = credentialsStore.RetriveAwsCredentials(new RetriveAwsCredentialsRequest()
{
ProfileName = profileName
});
Assert.IsFalse(retriveAwsCredentialsResponse.Success);
}
[Test]
public void UpdateAwsCredentials_WhenAwsProfileExists_IsSuccessful()
{
string profileName = $"NonEmptyProfileName-{Guid.NewGuid()}";
(string profileName, string accessKey, string secretKey) existingCredentials = EnsureValidCredentialsIsCreated(profileName: profileName);
string newAccessKey = $"NonEmptyAccessKey-{Guid.NewGuid()}";
string newSecretKey = $"NonEmptySecretKey-{Guid.NewGuid()}";
Assert.AreNotEqual(newAccessKey, existingCredentials.accessKey);
Assert.AreNotEqual(newSecretKey, existingCredentials.secretKey);
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
UpdateAwsCredentialsResponse updateAwsCredentialsResponse = credentialsStore.UpdateAwsCredentials(new UpdateAwsCredentialsRequest
{
ProfileName = profileName,
AccessKey = newAccessKey,
SecretKey = newSecretKey
});
Assert.IsTrue(updateAwsCredentialsResponse.Success);
RetriveAwsCredentialsResponse retriveAwsCredentialsResponse = credentialsStore.RetriveAwsCredentials(new RetriveAwsCredentialsRequest
{
ProfileName = profileName
});
Assert.NotNull(retriveAwsCredentialsResponse);
Assert.AreEqual(newAccessKey, retriveAwsCredentialsResponse.AccessKey);
Assert.AreEqual(newSecretKey, retriveAwsCredentialsResponse.SecretKey);
}
[Test]
public void UpdateAwsCredentials_WhenAwsProfileDoesNotExist_IsNotSuccessful()
{
string profileName = $"NonEmptyProfileName-{Guid.NewGuid()}";
string newAccessKey = $"NonEmptyAccessKey-{Guid.NewGuid()}";
string newSecretKey = $"NonEmptySecretKey-{Guid.NewGuid()}";
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
UpdateAwsCredentialsResponse updateAwsCredentialsResponse = credentialsStore.UpdateAwsCredentials(new UpdateAwsCredentialsRequest
{
ProfileName = profileName,
AccessKey = newAccessKey,
SecretKey = newSecretKey
});
Assert.IsFalse(updateAwsCredentialsResponse.Success);
Assert.IsNotEmpty(updateAwsCredentialsResponse.ErrorCode);
RetriveAwsCredentialsResponse retriveAwsCredentialsResponse = credentialsStore.RetriveAwsCredentials(new RetriveAwsCredentialsRequest
{
ProfileName = profileName
});
Assert.IsFalse(retriveAwsCredentialsResponse.Success);
}
[Test]
public void GetProfiles_WhenProfilesExist_IsSuccessful()
{
(string profileName, string accessKey, string secretKey) = EnsureValidCredentialsIsCreated();
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
GetProfilesResponse getProfilesResponse = credentialsStore.GetProfiles(new GetProfilesRequest());
Assert.IsTrue(getProfilesResponse.Profiles.Any(x => x == profileName));
}
[Test]
public void GetProfiles_WhenProfilesDoNotExist_IsNotSuccessful()
{
ICredentialsStore credentialsStore = Factory.CreateCredentialsManager();
GetProfilesResponse getProfilesResponse = credentialsStore.GetProfiles(new GetProfilesRequest());
Assert.IsTrue(!getProfilesResponse.Profiles.Any());
}
private (string profileName, string accessKey, string secretKey) EnsureValidCredentialsIsCreated(string profileName = default, string accessKey = default, string secretKey = default)
{
(bool isSucceed, string profileName, string accessKey, string secretKey) createCredentialsResponse = Factory.CreateCredentials(profileName, accessKey, secretKey);
Assert.IsTrue(createCredentialsResponse.isSucceed);
return (createCredentialsResponse.profileName, createCredentialsResponse.accessKey, createCredentialsResponse.secretKey);
}
}
}
| 231 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using System.Collections.Generic;
using System.Linq;
using Amazon;
using Amazon.CloudFormation;
using Amazon.CloudFormation.Model;
using Amazon.S3;
using Amazon.S3.Model;
using AmazonGameLiftPlugin.Core.DeploymentManagement;
using AmazonGameLiftPlugin.Core.Shared;
using AmazonGameLiftPlugin.Core.Shared.FileSystem;
using AmazonGameLiftPlugin.Core.Shared.FileZip;
using AmazonGameLiftPlugin.Core.Shared.S3Bucket;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.DeploymentManagement
{
[TestFixture]
public class DeploymentManagerTests
{
[Test]
[Ignore("Only for development")]
public void IntegrationTest()
{
string accessKey = "";
string secretKey = "";
var amazonS3Client = new AmazonS3Client(
accessKey,
secretKey,
RegionEndpoint.EUWest1
);
var deploymentManager = new DeploymentManager(
new AmazonCloudFormationWrapper(
accessKey,
secretKey,
"eu-west-1"
),
new AmazonS3Wrapper(amazonS3Client),
new FileWrapper(),
new FileZip());
}
[Test]
public void CreateChangeSet_WhenStackDoesNotExists_CreatesStackWithChangeSet()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.GetRegionEndpoint()).Returns("eu").Verifiable();
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Throws(new AmazonCloudFormationException("Stack does not exist"));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
amazonCloudFomrationClientMock.Verify(
x => x.CreateChangeSet(It.Is<CreateChangeSetRequest>(
p => p.StackName == stackName && p.ChangeSetType == ChangeSetType.CREATE)),
Times.Once()
);
Assert.IsTrue(response.Success);
}
[Test]
public void CreateChangeSet_WhenStackExists_CreatesChangeSetForUpdate()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.GetRegionEndpoint()).Returns("eu").Verifiable();
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>
{
new Stack()
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
amazonCloudFomrationClientMock.Verify(
x => x.CreateChangeSet(It.Is<CreateChangeSetRequest>(
p => p.StackName == stackName && p.ChangeSetType == ChangeSetType.UPDATE)),
Times.Once()
);
Assert.IsTrue(response.Success);
}
[Test]
public void CreateChangeSet_WhenBootstrapDoesNotExist_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(false);
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.BucketDoesNotExist, response.ErrorCode);
}
[Test]
public void CreateChangeSet_WhenUploadingLambdaIsNotSuccessful_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
fileZipMock.Setup(x => x.Zip(It.IsAny<string>(), It.IsAny<string>())).Throws(new System.Exception());
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName,
LambdaSourcePath = "NonEmptyPath",
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
}
[Test]
public void CreateChangeSet_WhenTemplateUploadIsNotSuccessful_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
s3WrapperMock.Setup(x => x.PutObject(It.IsAny<PutObjectRequest>()))
.Throws(new AmazonS3Exception("BucketDoesNotExists"));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.AwsError, response.ErrorCode);
}
[Test]
public void CreateChangeSet_WhenSKDThrowsAlreadyExistsException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.GetRegionEndpoint()).Returns("eu").Verifiable();
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
amazonCloudFomrationClientMock.Setup(x => x.CreateChangeSet(It.IsAny<CreateChangeSetRequest>())).Throws(new AlreadyExistsException(""));
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>
{
new Stack()
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.ResourceWithTheNameRequestetAlreadyExists, response.ErrorCode);
}
[Test]
public void CreateChangeSet_WhenSKDThrowsInsufficientCapabilitiesException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.GetRegionEndpoint()).Returns("eu").Verifiable();
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
amazonCloudFomrationClientMock.Setup(x => x.CreateChangeSet(It.IsAny<CreateChangeSetRequest>())).Throws(new InsufficientCapabilitiesException(""));
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>
{
new Stack()
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InsufficientCapabilities, response.ErrorCode);
}
[Test]
public void CreateChangeSet_WhenSKDThrowsLimitExceededException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string bootstrapBucketName = "bucketname1";
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
s3WrapperMock.Setup(x => x.GetRegionEndpoint()).Returns("eu").Verifiable();
s3WrapperMock.Setup(x => x.DoesBucketExist(bootstrapBucketName))
.Returns(true);
amazonCloudFomrationClientMock.Setup(x => x.CreateChangeSet(It.IsAny<CreateChangeSetRequest>())).Throws(new LimitExceededException(""));
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>
{
new Stack()
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CreateChangeSetResponse response =
deploymentManager.CreateChangeSet(new Core.DeploymentManagement.Models.CreateChangeSetRequest
{
StackName = stackName,
ParametersFilePath = "NonEmptyPath",
TemplateFilePath = "NonEmptyPath",
BootstrapBucketName = bootstrapBucketName
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.LimitExceeded, response.ErrorCode);
}
[Test]
public void DescribeStack_WhenStackExists_ReturnsOutputsWithStatus()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
string outputKey1 = "Key1";
string outputKey2 = "Key2";
var stack = new Stack
{
StackName = stackName,
Outputs = new List<Output>
{
new Output { OutputKey=outputKey1,OutputValue= "Value1" },
new Output { OutputKey=outputKey2,OutputValue= "Value2" }
}
};
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>()
{
stack
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DescribeStackResponse response =
deploymentManager.DescribeStack(new Core.DeploymentManagement.Models.DescribeStackRequest
{
StackName = stackName,
OutputKeys = new List<string>
{
outputKey1,
outputKey2
}
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(response.Success);
Assert.AreEqual(2, response.Outputs.Count);
Assert.IsTrue(response.Outputs.ContainsKey(outputKey1));
Assert.IsTrue(response.Outputs.ContainsKey(outputKey2));
}
[Test]
public void DescribeStack_WhenStackDoesNotExists_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>()
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DescribeStackResponse response =
deploymentManager.DescribeStack(new Core.DeploymentManagement.Models.DescribeStackRequest
{
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
}
[Test]
public void DescribeChangeSet_WhenChangeSetExists_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.DescribeChangeSet(
It.Is<DescribeChangeSetRequest>(p => p.ChangeSetName == changeSetName && p.StackName == stackName)))
.Returns(new DescribeChangeSetResponse
{
Changes = new List<Change>
{
new Change(),
new Change()
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DescribeChangeSetResponse response = deploymentManager.DescribeChangeSet(new Core.DeploymentManagement.Models.DescribeChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(response.Success);
Assert.NotNull(response.Changes);
Assert.AreEqual(2, response.Changes.Count());
}
[Test]
public void DescribeChangeSet_WhenChangeSetDoesNotExists_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.DescribeChangeSet(
It.Is<DescribeChangeSetRequest>(p => p.ChangeSetName == changeSetName && p.StackName == stackName)))
.Throws(new AmazonCloudFormationException("ChangeSet does not exists"));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DescribeChangeSetResponse response = deploymentManager.DescribeChangeSet(new Core.DeploymentManagement.Models.DescribeChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.AwsError, response.ErrorCode);
Assert.AreEqual("ChangeSet does not exists", response.ErrorMessage);
}
[Test]
public void ExecuteChangeSet_WhenChangeSetExists_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.ExecuteChangeSet(
It.Is<ExecuteChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Returns(new ExecuteChangeSetResponse { HttpStatusCode = System.Net.HttpStatusCode.OK });
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.ExecuteChangeSetResponse response
= deploymentManager.ExecuteChangeSet(new Core.DeploymentManagement.Models.ExecuteChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(response.Success);
}
[Test]
public void ExecuteChangeSet_WhenChangeSetDoesNotExists_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.ExecuteChangeSet(
It.Is<ExecuteChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Throws(new AmazonCloudFormationException("ChangeSet does not exists"));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.ExecuteChangeSetResponse response
= deploymentManager.ExecuteChangeSet(new Core.DeploymentManagement.Models.ExecuteChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.AwsError, response.ErrorCode);
Assert.AreEqual("ChangeSet does not exists", response.ErrorMessage);
}
[Test]
public void ExecuteChangeSet_WhenSDKThrowsTokenAlreadyExistsException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.ExecuteChangeSet(
It.Is<ExecuteChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Throws(new TokenAlreadyExistsException(""));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.ExecuteChangeSetResponse response
= deploymentManager.ExecuteChangeSet(new Core.DeploymentManagement.Models.ExecuteChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.TokenAlreadyExists, response.ErrorCode);
}
[Test]
public void ExecuteChangeSet_WhenSDKThrowsInvalidChangeSetStatusException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.ExecuteChangeSet(
It.Is<ExecuteChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Throws(new InvalidChangeSetStatusException(""));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.ExecuteChangeSetResponse response
= deploymentManager.ExecuteChangeSet(new Core.DeploymentManagement.Models.ExecuteChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InvalidChangeSetStatus, response.ErrorCode);
}
[Test]
public void ExecuteChangeSet_WhenSDKThrowsInsufficientCapabilitiesException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.ExecuteChangeSet(
It.Is<ExecuteChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Throws(new InsufficientCapabilitiesException(""));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.ExecuteChangeSetResponse response
= deploymentManager.ExecuteChangeSet(new Core.DeploymentManagement.Models.ExecuteChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InsufficientCapabilities, response.ErrorCode);
}
[Test]
public void ExecuteChangeSet_WhenSDKThrowsChangeSetNotFoundException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.ExecuteChangeSet(
It.Is<ExecuteChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Throws(new ChangeSetNotFoundException(""));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.ExecuteChangeSetResponse response
= deploymentManager.ExecuteChangeSet(new Core.DeploymentManagement.Models.ExecuteChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.ChangeSetNotFound, response.ErrorCode);
}
[Test]
public void DescribeChangeSet_WhenSDKThrowsChangeSetNotFoundException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string changeSetName = "NonEmpty";
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(x => x.DescribeChangeSet(
It.Is<DescribeChangeSetRequest>(p => p.ChangeSetName == changeSetName
&& p.StackName == stackName)))
.Throws(new ChangeSetNotFoundException("ChangeSet does not exists"));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DescribeChangeSetResponse response
= deploymentManager.DescribeChangeSet(new Core.DeploymentManagement.Models.DescribeChangeSetRequest
{
ChangeSetName = changeSetName,
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.ChangeSetNotFound, response.ErrorCode);
}
[Test]
public void StackExists_WhenStackExists_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Returns(new DescribeStacksResponse
{
HttpStatusCode = System.Net.HttpStatusCode.OK,
Stacks = new List<Stack>
{
new Stack()
}
});
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.StackExistsResponse response
= deploymentManager.StackExists(new Core.DeploymentManagement.Models.StackExistsRequest
{
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(response.Success);
Assert.IsTrue(response.Exists);
}
[Test]
public void StackExists_WhenStackDoesNotExists_ReturnsNotExists()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
string stackName = "ValidStackName";
amazonCloudFomrationClientMock.Setup(
x => x.DescribeStacks(
It.Is<DescribeStacksRequest>(p => p.StackName == stackName)))
.Throws(new AmazonCloudFormationException("Stack Does not exists"));
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.StackExistsResponse response
= deploymentManager.StackExists(new Core.DeploymentManagement.Models.StackExistsRequest
{
StackName = stackName
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(response.Exists);
}
[Test]
public void UploadServerBuild_WhenParametersAreEmpty_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.UploadServerBuildResponse response = deploymentManager.UploadServerBuild(new Core.DeploymentManagement.Models.UploadServerBuildRequest());
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InvalidParameters, response.ErrorCode);
}
[Test]
public void UploadServerBuild_WhenFileDoesNotExist_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(false).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.UploadServerBuildResponse response = deploymentManager.UploadServerBuild(new Core.DeploymentManagement.Models.UploadServerBuildRequest()
{
FilePath = "InvalidFilePath",
BucketName = "NonEmptyBucketName",
BuildS3Key = "NonEmptyS3Key"
});
fileWrapperMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.FileNotFound, response.ErrorCode);
}
[Test]
public void UploadServerBuild_WhenAmazonS3ExceptionWasThrown_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true).Verifiable();
s3WrapperMock.Setup(x => x.PutObject(It.IsAny<PutObjectRequest>())).Throws(
new AmazonS3Exception("S3Exception", Amazon.Runtime.ErrorType.Sender, "S3Exception",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.UploadServerBuildResponse response = deploymentManager.UploadServerBuild(new Core.DeploymentManagement.Models.UploadServerBuildRequest()
{
FilePath = "NonEmptyFilePath",
BucketName = "NonEmptyBucketName",
BuildS3Key = "NonEmptyS3Key"
});
fileWrapperMock.Verify();
s3WrapperMock.Verify();
Assert.IsFalse(response.Success);
Assert.IsNotEmpty(response.ErrorMessage);
}
[Test]
public void UploadServerBuild_WhenValidParametersArePassed_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true).Verifiable();
s3WrapperMock.Setup(x => x.GetRegionEndpoint()).Returns("eu").Verifiable();
s3WrapperMock.Setup(x => x.PutObject(It.IsAny<PutObjectRequest>())).Returns(new PutObjectResponse()).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.UploadServerBuildResponse response = deploymentManager.UploadServerBuild(new Core.DeploymentManagement.Models.UploadServerBuildRequest()
{
FilePath = "NonEmptyFilePath",
BucketName = "NonEmptyBucketName",
BuildS3Key = "NonEmptyS3Key"
});
fileWrapperMock.Verify();
s3WrapperMock.Verify();
Assert.IsTrue(response.Success);
}
[Test]
public void CancelDeployment_WhenValidStackUpdateIsInProgress_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.CancelDeployment(It.IsAny<CancelUpdateStackRequest>())).Returns(new CancelUpdateStackResponse()).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CancelDeploymentResponse cancelResponse = deploymentManager.CancelDeployment(new Core.DeploymentManagement.Models.CancelDeploymentRequest()
{
StackName = "ValidStackName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(cancelResponse.Success);
}
[Test]
public void CancelDeployment_WhenValidStackDoesNotExist_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.CancelDeployment(It.IsAny<CancelUpdateStackRequest>())).Throws(
new AmazonCloudFormationException("StackDoesNotExist", Amazon.Runtime.ErrorType.Sender, "StackDoesNotExist",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CancelDeploymentResponse cancelResponse = deploymentManager.CancelDeployment(new Core.DeploymentManagement.Models.CancelDeploymentRequest()
{
StackName = "InvalidStackName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(cancelResponse.Success);
Assert.AreEqual(cancelResponse.ErrorCode, ErrorCode.AwsError);
Assert.IsNotEmpty(cancelResponse.ErrorMessage);
}
[Test]
public void CancelDeployment_WhenSKDThrowsTokenAlreadyExistsException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.CancelDeployment(It.IsAny<CancelUpdateStackRequest>())).Throws(
new TokenAlreadyExistsException("TokenAlreadyExists", Amazon.Runtime.ErrorType.Sender, "TokenAlreadyExists",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CancelDeploymentResponse cancelResponse = deploymentManager.CancelDeployment(new Core.DeploymentManagement.Models.CancelDeploymentRequest()
{
StackName = "InvalidStackName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(cancelResponse.Success);
Assert.AreEqual(cancelResponse.ErrorCode, ErrorCode.TokenAlreadyExists);
Assert.IsNotEmpty(cancelResponse.ErrorMessage);
}
[Test]
public void CancelDeployment_WhenInValidSParametersArePassed_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.CancelDeploymentResponse cancelResponse = deploymentManager.CancelDeployment(new Core.DeploymentManagement.Models.CancelDeploymentRequest()
{
StackName = string.Empty
});
Assert.IsFalse(cancelResponse.Success);
Assert.AreEqual(cancelResponse.ErrorCode, ErrorCode.InvalidParameters);
}
[Test]
public void DeleteChangeSet_WhenValidParametersArePassed_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.DeleteChangeSet(It.IsAny<DeleteChangeSetRequest>())).Returns(new DeleteChangeSetResponse()).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteChangeSetResponse deleteResponse = deploymentManager.DeleteChangeSet(new Core.DeploymentManagement.Models.DeleteChangeSetRequest()
{
StackName = "ValidStackName",
ChangeSetName = "ValidChangeSetName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(deleteResponse.Success);
}
[Test]
public void DeleteChangeSet_WhenStackDoesNotExist_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.DeleteChangeSet(It.IsAny<DeleteChangeSetRequest>())).Throws(
new AmazonCloudFormationException("StackDoesNotExist", Amazon.Runtime.ErrorType.Sender, "StackDoesNotExist",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteChangeSetResponse deleteResponse = deploymentManager.DeleteChangeSet(new Core.DeploymentManagement.Models.DeleteChangeSetRequest()
{
StackName = "NonExistingStack",
ChangeSetName = "NonExistingChangeSet"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(deleteResponse.Success);
Assert.AreEqual(deleteResponse.ErrorCode, ErrorCode.AwsError);
Assert.IsNotEmpty(deleteResponse.ErrorMessage);
}
[Test]
public void DeleteChangeSet_WhenSDKThowsInvalidChangeSetStatusException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.DeleteChangeSet(It.IsAny<DeleteChangeSetRequest>())).Throws(
new InvalidChangeSetStatusException("InvalidChangeSetStatus", Amazon.Runtime.ErrorType.Sender, "InvalidChangeSetStatus",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteChangeSetResponse deleteResponse = deploymentManager.DeleteChangeSet(new Core.DeploymentManagement.Models.DeleteChangeSetRequest()
{
StackName = "NonExistingStack",
ChangeSetName = "NonExistingChangeSet"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(deleteResponse.Success);
Assert.AreEqual(deleteResponse.ErrorCode, ErrorCode.InvalidChangeSetStatus);
Assert.IsNotEmpty(deleteResponse.ErrorMessage);
}
[Test]
public void DeleteChangeSet_WhenEmptyParametersArePassed_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteChangeSetResponse deleteResponse = deploymentManager.DeleteChangeSet(new Core.DeploymentManagement.Models.DeleteChangeSetRequest()
{
StackName = string.Empty,
ChangeSetName = string.Empty
});
Assert.IsFalse(deleteResponse.Success);
Assert.AreEqual(deleteResponse.ErrorCode, ErrorCode.InvalidParameters);
}
[Test]
public void DeleteStack_WhenValidParametersArePassed_IsSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.DeleteStack(It.IsAny<DeleteStackRequest>())).Returns(new DeleteStackResponse()).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteStackResponse deleteResponse = deploymentManager.DeleteStack(new Core.DeploymentManagement.Models.DeleteStackRequest()
{
StackName = "ValidStackName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsTrue(deleteResponse.Success);
}
[Test]
public void DeleteStack_WhenStackDoesNotExist_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.DeleteStack(It.IsAny<DeleteStackRequest>())).Throws(
new AmazonCloudFormationException("StackDoesNotExist", Amazon.Runtime.ErrorType.Sender, "StackDoesNotExist",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteStackResponse deleteResponse = deploymentManager.DeleteStack(new Core.DeploymentManagement.Models.DeleteStackRequest()
{
StackName = "NonExistingStackName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(deleteResponse.Success);
Assert.AreEqual(deleteResponse.ErrorCode, ErrorCode.AwsError);
Assert.IsNotEmpty(deleteResponse.ErrorMessage);
}
[Test]
public void DeleteStack_WhenSDKThowsTokenAlreadyExistsException_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
amazonCloudFomrationClientMock.Setup(x => x.DeleteStack(It.IsAny<DeleteStackRequest>())).Throws(
new TokenAlreadyExistsException("TokenAlreadyExists", Amazon.Runtime.ErrorType.Sender, "TokenAlreadyExists",
"", System.Net.HttpStatusCode.BadRequest)).Verifiable();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteStackResponse deleteResponse = deploymentManager.DeleteStack(new Core.DeploymentManagement.Models.DeleteStackRequest()
{
StackName = "NonExistingStackName"
});
amazonCloudFomrationClientMock.Verify();
Assert.IsFalse(deleteResponse.Success);
Assert.AreEqual(deleteResponse.ErrorCode, ErrorCode.TokenAlreadyExists);
Assert.IsNotEmpty(deleteResponse.ErrorMessage);
}
[Test]
public void DeleteStack_WhenEmptyParametersArePassed_IsNotSuccessful()
{
var amazonCloudFomrationClientMock = new Mock<IAmazonCloudFormationWrapper>();
var s3WrapperMock = new Mock<IAmazonS3Wrapper>();
var fileWrapperMock = new Mock<IFileWrapper>();
var fileZipMock = new Mock<IFileZip>();
var deploymentManager = new DeploymentManager(
amazonCloudFomrationClientMock.Object,
s3WrapperMock.Object,
fileWrapperMock.Object,
fileZipMock.Object
);
Core.DeploymentManagement.Models.DeleteStackResponse deleteResponse = deploymentManager.DeleteStack(new Core.DeploymentManagement.Models.DeleteStackRequest()
{
StackName = string.Empty
});
Assert.IsFalse(deleteResponse.Success);
Assert.AreEqual(deleteResponse.ErrorCode, ErrorCode.InvalidParameters);
}
}
}
| 1,371 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using AmazonGameLiftPlugin.Core.BucketManagement;
using AmazonGameLiftPlugin.Core.Shared.S3Bucket;
using Moq;
namespace AmazonGameLiftPlugin.Core.Tests.Factories
{
public class BucketStoreFactory
{
public BucketStore CreateBucketStore(IAmazonS3Wrapper amazonS3Wrapper = default)
{
amazonS3Wrapper = amazonS3Wrapper ?? new Mock<IAmazonS3Wrapper>().Object;
return new BucketStore(amazonS3Wrapper);
}
}
}
| 20 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using AmazonGameLiftPlugin.Core.CredentialManagement;
using AmazonGameLiftPlugin.Core.CredentialManagement.Models;
using AmazonGameLiftPlugin.Core.Shared.FileSystem;
using Moq;
namespace AmazonGameLiftPlugin.Core.Tests.Factories
{
public class CredentialsStoreFactory
{
private readonly string _sharedCredentialsFilePath;
public CredentialsStoreFactory(string sharedCredentialsFilePath)
{
_sharedCredentialsFilePath = sharedCredentialsFilePath;
}
public ICredentialsStore CreateCredentialsManager(string testFileContents = "")
{
var fileMock = new Mock<IFileWrapper>();
fileMock.Setup(target => target.ReadAllText(It.IsAny<string>())).Returns(testFileContents);
return new CredentialsStore(fileMock.Object, _sharedCredentialsFilePath);
}
public (bool isSucceed, string profileName, string accessKey, string secretKey) CreateCredentials(string profileName = default, string accessKey = default, string secretKey = default)
{
profileName = profileName ?? $"NonEmptyProfileName-{Guid.NewGuid()}";
accessKey = accessKey ?? $"NonEmptyAccessKey-{Guid.NewGuid()}";
secretKey = secretKey ?? $"NonEmptySecretKey-{Guid.NewGuid()}";
// Store Credentials
ICredentialsStore credentialsManager = CreateCredentialsManager();
SaveAwsCredentialsResponse response = credentialsManager.SaveAwsCredentials(new SaveAwsCredentialsRequest()
{
AccessKey = accessKey,
SecretKey = secretKey,
ProfileName = profileName
});
return (response.Success, profileName, accessKey, secretKey);
}
}
}
| 47 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using AmazonGameLiftPlugin.Core.SettingsManagement;
using AmazonGameLiftPlugin.Core.SettingsManagement.Models;
using AmazonGameLiftPlugin.Core.Shared.FileSystem;
using AmazonGameLiftPlugin.Core.Shared.SettingsStore;
namespace AmazonGameLiftPlugin.Core.Tests.Factories
{
public class SettingsStoreFactory
{
private readonly IFileWrapper _fileWrapper;
private readonly IStreamWrapper _yamlStreamWrapper;
private readonly string _settingsFilePath;
public SettingsStoreFactory(IFileWrapper fileWrapper, IStreamWrapper yamlStreamWrapper = default, string settingsFilePath = default)
{
_fileWrapper = fileWrapper;
_yamlStreamWrapper = yamlStreamWrapper;
_settingsFilePath = settingsFilePath;
}
public SettingsStore CreateSettingsStore(IFileWrapper fileWrapper = default, IStreamWrapper yamlStreamWrapper = default, string settingsFilePath = default)
{
return new SettingsStore(fileWrapper ?? _fileWrapper, yamlStreamWrapper ?? _yamlStreamWrapper, settingsFilePath ?? _settingsFilePath);
}
public (bool isSucceed, string key, string value) GetCreatedSettings(string key = default, string value = default)
{
SettingsStore settingsStore = CreateSettingsStore();
key = key ?? Guid.NewGuid().ToString();
value = value ?? Guid.NewGuid().ToString();
PutSettingResponse writeResponse = settingsStore.PutSetting(new PutSettingRequest()
{
Key = key,
Value = value,
});
return (writeResponse.Success, key, value);
}
}
}
| 47 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using System.Diagnostics;
using AmazonGameLiftPlugin.Core.GameLiftLocalTesting;
using AmazonGameLiftPlugin.Core.GameLiftLocalTesting.Models;
using AmazonGameLiftPlugin.Core.Shared;
using AmazonGameLiftPlugin.Core.Shared.ProcessManagement;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.GameLiftLocalTesting
{
[TestFixture]
public class GameLiftProcessTests
{
[Test]
public void Start_WhenParametersIsNotValid_IsNotSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
StartResponse response = gameliftProcess.Start(new StartRequest
{
GameLiftLocalFilePath = null
});
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InvalidParameters, response.ErrorCode);
}
[Test]
public void Start_WhenProcessIsStarted_IsSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
string expectedArguments = "-jar \"\\NonEmptyPath\" -p \"100\"";
processWrapperMock.Setup(x => x.Start(It.Is<ProcessStartInfo>(
p => p.Arguments == expectedArguments))
)
.Returns(1);
StartResponse response = gameliftProcess.Start(
new StartRequest
{
Port = 100,
GameLiftLocalFilePath = @"\NonEmptyPath"
});
processWrapperMock.Verify();
Assert.IsTrue(response.Success);
Assert.AreEqual(1, response.ProcessId);
}
[Test]
public void Start_WhenProcessThrowsException_IsNotSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
processWrapperMock.Setup(x => x.Start(It.IsAny<ProcessStartInfo>()))
.Throws(new Exception());
StartResponse response = gameliftProcess.Start(
new StartRequest
{
GameLiftLocalFilePath = "NonEmptyPath"
});
processWrapperMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
}
[Test]
public void Stop_WhenProcessStoppped_IsSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
processWrapperMock.Setup(x => x.Kill(1));
StopResponse response = gameliftProcess.Stop(
new StopRequest
{
ProcessId = 1
});
processWrapperMock.Verify();
Assert.IsTrue(response.Success);
}
[Test]
public void Stop_WhenProcessThrows_IsNotSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
processWrapperMock.Setup(x => x.Kill(1))
.Throws(new Exception());
StopResponse response = gameliftProcess.Stop(
new StopRequest
{
ProcessId = 1
});
processWrapperMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
}
[Test]
public void RunLocalServer_WhenProcessStarts_IsSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
string filePath = "NonEmptyPath";
bool showWindow = false;
processWrapperMock.Setup(x => x.Start(
It.Is<ProcessStartInfo>(p => p.FileName == filePath
&& p.UseShellExecute == showWindow)))
.Returns(1);
RunLocalServerResponse response = gameliftProcess.RunLocalServer(new RunLocalServerRequest
{
FilePath = filePath,
ShowWindow = showWindow
});
processWrapperMock.Verify();
Assert.IsTrue(response.Success);
Assert.AreEqual(1, response.ProcessId);
}
[Test]
public void RunLocalServer_WhenParametersIsNotValid_IsNotSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
RunLocalServerResponse response = gameliftProcess.RunLocalServer(null);
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InvalidParameters, response.ErrorCode);
}
[Test]
public void RunLocalServer_WhenProcessThrowsException_IsNotSuccessful()
{
var processWrapperMock = new Mock<IProcessWrapper>();
var gameliftProcess = new GameLiftProcess(
processWrapperMock.Object
);
processWrapperMock.Setup(x => x.Start(It.IsAny<ProcessStartInfo>()))
.Throws(new Exception());
RunLocalServerResponse response = gameliftProcess.RunLocalServer(
new RunLocalServerRequest
{
FilePath = "NonEmptyPath"
});
processWrapperMock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
}
}
}
| 199 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using AmazonGameLiftPlugin.Core.JavaCheck;
using AmazonGameLiftPlugin.Core.Shared.ProcessManagement;
namespace AmazonGameLiftPlugin.Core.Tests.InstalledJavaVersionCheck
{
public class InstalledJavaVersionProviderFactory
{
public static IInstalledJavaVersionProvider Create(IProcessWrapper processWrapper)
{
return new InstalledJavaVersionProvider(processWrapper);
}
}
}
| 17 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System.Diagnostics;
using AmazonGameLiftPlugin.Core.JavaCheck;
using AmazonGameLiftPlugin.Core.JavaCheck.Models;
using AmazonGameLiftPlugin.Core.Shared.ProcessManagement;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.InstalledJavaVersionCheck
{
[TestFixture]
public class InstalledJavaVersionProviderTests
{
private CheckInstalledJavaVersionResponse GetCheckInstalledJavaVersionResponse(string output, int minVersion) {
var processWrapperMock = new Mock<IProcessWrapper>();
processWrapperMock.Setup(x => x.GetProcessOutput(
It.IsAny<ProcessStartInfo>())
).Returns(output);
IInstalledJavaVersionProvider installedJavaVersionProvider =
InstalledJavaVersionProviderFactory.Create(processWrapperMock.Object);
CheckInstalledJavaVersionResponse response =
installedJavaVersionProvider.CheckInstalledJavaVersion(new CheckInstalledJavaVersionRequest
{
ExpectedMinimumJavaMajorVersion = minVersion
});
processWrapperMock.Verify();
return response;
}
[Test]
public void CheckInstalledJavaVersion_WhenExpectedJavaVersionIsInstalled()
{
var output = "java version \"1.8.0_291\"";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsTrue(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenExpectedJavaVersionIsMultiline()
{
var output = @"
Picked up JAVA_TOOL_OPTIONS: -Dlog4j2.formatMsgNoLookups=true
openjdk version ""1.8.0_322""
OpenJDK Runtime Environment Corretto-8.322.06.1 (build 1.8.0_322-b06)
OpenJDK 64-Bit Server VM Corretto-8.322.06.1 (build 25.322-b06, mixed mode)
";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsTrue(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenExpectedJavaVersionUsesAlternateFormat()
{
var output = "java version \"9.0.1\"";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsTrue(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenExpectedJavaVersionUsesShortFormat()
{
var output = "openjdk version \"19\"";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsTrue(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenExpectedJavaVersionUsesShortFormatAndIsV1()
{
var output = "openjdk version \"1\"";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsFalse(response.IsInstalled);
var response2 = GetCheckInstalledJavaVersionResponse(output, 1);
Assert.IsTrue(response2.Success, "Request was not successful");
Assert.IsTrue(response2.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WithSecurityPatch()
{
var output = "java version \"1.09.1.1\"";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsTrue(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenJavaVersionIsTooLow()
{
var output = "java version \"1.8.0_291\"";
var response = GetCheckInstalledJavaVersionResponse(output, 11);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsFalse(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenJavaIsNotInstalled()
{
var output = "java is not installed";
var response = GetCheckInstalledJavaVersionResponse(output, 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsFalse(response.IsInstalled);
}
[Test]
public void CheckInstalledJavaVersion_WhenJavaIsEmpty()
{
var response = GetCheckInstalledJavaVersionResponse("", 8);
Assert.IsTrue(response.Success, "Request was not successful");
Assert.IsFalse(response.IsInstalled);
}
}
}
| 125 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using System.Collections.Generic;
using System.Net.NetworkInformation;
using System.Threading.Tasks;
using AmazonGameLiftPlugin.Core.Latency;
using AmazonGameLiftPlugin.Core.Latency.Models;
using AmazonGameLiftPlugin.Core.Shared;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.Latency
{
[TestFixture]
public class LatencyServiceTests
{
[Test]
public void GetLatencies_WhenEndpointIsAccessible_CalculatesCorrectAverageLatencyAndReturns()
{
var pingWrapperMock = new Mock<IPingWrapper>();
string endpoint = "ec2.us-east-1.amazonaws.com";
int expectedAverageLatency = 3;
//Simulate multiple ping to the same address
pingWrapperMock.SetupSequence(x => x.SendPingAsync(endpoint))
.ReturnsAsync(new PingResult
{
RoundtripTime = 1
})
.ReturnsAsync(new PingResult
{
RoundtripTime = 2
})
.ReturnsAsync(new PingResult
{
RoundtripTime = 3
})
.ReturnsAsync(new PingResult
{
RoundtripTime = 4
})
.ReturnsAsync(new PingResult
{
RoundtripTime = 5
});
var sut = new LatencyService(pingWrapperMock.Object);
GetLatenciesResponse response =
sut.GetLatencies(new GetLatenciesRequest
{
Regions = new List<string>()
{
"us-east-1"
}
}).Result;
Assert.IsTrue(response.Success);
Assert.AreEqual(1, response.RegionLatencies.Count);
Assert.IsTrue(response.RegionLatencies.ContainsKey("us-east-1"));
Assert.AreEqual(expectedAverageLatency, response.RegionLatencies["us-east-1"]);
}
[Test]
public void GetLatencies_WhenRegionIsNull_IsNotSuccessful()
{
var pingWrapperMock = new Mock<IPingWrapper>();
var sut = new LatencyService(pingWrapperMock.Object);
GetLatenciesResponse response =
sut.GetLatencies(new GetLatenciesRequest
{
Regions = null
}).Result;
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InvalidParameters, response.ErrorCode);
}
[Test]
public void GetLatencies_WhenRegionIsEmpty_IsNotSuccessful()
{
var pingWrapperMock = new Mock<IPingWrapper>();
var sut = new LatencyService(pingWrapperMock.Object);
GetLatenciesResponse response =
sut.GetLatencies(new GetLatenciesRequest
{
Regions = new List<string>()
}).Result;
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.InvalidParameters, response.ErrorCode);
}
[Test]
public void GetLatencies_WhenPingThrows_IsNotSuccessful()
{
var pingWrapperMock = new Mock<IPingWrapper>();
pingWrapperMock.Setup(x => x.SendPingAsync(It.IsAny<string>()))
.Throws(new Exception());
var sut = new LatencyService(pingWrapperMock.Object);
GetLatenciesResponse response =
sut.GetLatencies(new GetLatenciesRequest
{
Regions = new List<string> { "us-east-1" }
}).Result;
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
}
}
}
| 123 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
[assembly: AssemblyTitle("AmazonGameLiftPlugin.Core.Tests")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Amazon")]
[assembly: AssemblyProduct("AmazonGameLiftPlugin.Core.Tests")]
[assembly: AssemblyCopyright("Copyright © Amazon 2021")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
[assembly: ComVisible(false)]
[assembly: Guid("e65f9109-48e9-4698-9c1b-5ef88bb8458c")]
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]
| 24 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System;
using System.IO;
using AmazonGameLiftPlugin.Core.SettingsManagement;
using AmazonGameLiftPlugin.Core.SettingsManagement.Models;
using AmazonGameLiftPlugin.Core.Shared;
using AmazonGameLiftPlugin.Core.Shared.FileSystem;
using AmazonGameLiftPlugin.Core.Tests.Factories;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.SettingsManagement
{
[TestFixture]
public class SettingsStoreTests
{
private string FilePath { get; set; }
private SettingsStoreFactory Factory { get; set; }
[SetUp]
public void Init()
{
FilePath = Path.Combine(Directory.GetCurrentDirectory(), $"settings.yaml");
Factory = new SettingsStoreFactory(new FileWrapper(), settingsFilePath: FilePath);
}
[TearDown]
public void Cleanup()
{
File.Delete(FilePath);
}
[Test]
public void GetSetting_WhenKeyExists_IsSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = existingSettings.key
});
Assert.IsTrue(getSettingsResponse.Success);
Assert.AreEqual(getSettingsResponse.Value, existingSettings.value);
}
[Test]
public void GetSetting_WhenPassedKeyIsEmpty_IsNotSuccessful()
{
SettingsStore settingsStore = Factory.CreateSettingsStore();
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = string.Empty
});
Assert.IsFalse(getSettingsResponse.Success);
Assert.IsNotEmpty(getSettingsResponse.ErrorCode);
Assert.AreSame(getSettingsResponse.ErrorCode, ErrorCode.InvalidParameters);
}
[Test]
public void GetSetting_WhenPassedKeyDoesNotExist_IsNotSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = Guid.NewGuid().ToString()
});
Assert.IsFalse(getSettingsResponse.Success);
Assert.IsNotEmpty(getSettingsResponse.ErrorCode);
Assert.AreSame(getSettingsResponse.ErrorCode, ErrorCode.NoSettingsKeyFound);
}
[Test]
public void GetSetting_WhenPassedKeyWasCleanedAndDoesNotExist_IsNotSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
ClearSettingResponse clearResponse = settingsStore.ClearSetting(new ClearSettingRequest() { Key = existingSettings.key });
Assert.True(clearResponse.Success);
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = existingSettings.key
});
Assert.IsFalse(getSettingsResponse.Success);
Assert.IsNotEmpty(getSettingsResponse.ErrorCode);
Assert.AreSame(getSettingsResponse.ErrorCode, ErrorCode.NoSettingsKeyFound);
}
[Test]
public void GetSetting_WhenFileDoesNotExist_IsNotSuccessful()
{
SettingsStore settingsStore = Factory.CreateSettingsStore();
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = Guid.NewGuid().ToString()
});
Assert.IsFalse(getSettingsResponse.Success);
Assert.IsNotEmpty(getSettingsResponse.ErrorCode);
Assert.AreSame(getSettingsResponse.ErrorCode, ErrorCode.NoSettingsFileFound);
}
[Test]
public void GetSetting_WhenFileIsInvalid_IsNotSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
var fileWrapperMock = new Mock<IFileWrapper>();
string emptyContenent = string.Empty;
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(emptyContenent);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
ISettingsStore settingsStore = Factory.CreateSettingsStore(fileWrapperMock.Object);
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = Guid.NewGuid().ToString()
});
Assert.IsFalse(getSettingsResponse.Success);
Assert.IsNotEmpty(getSettingsResponse.ErrorCode);
}
[Test]
public void PutSettings_WhenKeyValueIsCorrect_IsSuccessful()
{
SettingsStore settingsStore = Factory.CreateSettingsStore();
string key = "NonEmptyKey";
string value = "NonEmptyValue";
PutSettingResponse putSettingsResponse = settingsStore.PutSetting(new PutSettingRequest
{
Key = key,
Value = value
});
Assert.True(putSettingsResponse.Success);
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = key
});
Assert.IsTrue(getSettingsResponse.Success);
Assert.AreEqual(value, getSettingsResponse.Value);
}
[Test]
public void PutSettings_WhenKeyValueIsEmpty_IsNotSuccessful()
{
SettingsStore settingsStore = Factory.CreateSettingsStore();
PutSettingResponse putSettingsResponse = settingsStore.PutSetting(new PutSettingRequest
{
Key = string.Empty,
Value = string.Empty,
});
Assert.IsFalse(putSettingsResponse.Success);
Assert.AreSame(putSettingsResponse.ErrorCode, ErrorCode.InvalidParameters);
}
[Test]
public void PutSettings_WhenFileIsInvalid_IsNotSuccessful()
{
var fileWrapperMock = new Mock<IFileWrapper>();
string emptyContenent = string.Empty;
fileWrapperMock.Setup(x => x.ReadAllText(It.IsAny<string>())).Returns(emptyContenent);
fileWrapperMock.Setup(x => x.FileExists(It.IsAny<string>())).Returns(true);
ISettingsStore settingsStore = Factory.CreateSettingsStore(fileWrapperMock.Object);
PutSettingResponse putSettingsResponse = settingsStore.PutSetting(new PutSettingRequest
{
Key = Guid.NewGuid().ToString(),
Value = Guid.NewGuid().ToString(),
});
Assert.IsFalse(putSettingsResponse.Success);
Assert.AreSame(putSettingsResponse.ErrorCode, ErrorCode.InvalidSettingsFile);
}
[Test]
public void PutSettings_WhenKeyExists_IsSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
string newValue = Guid.NewGuid().ToString();
PutSettingResponse putSettingsResponse = settingsStore.PutSetting(new PutSettingRequest
{
Key = existingSettings.key,
Value = newValue,
});
Assert.IsTrue(putSettingsResponse.Success);
Assert.AreNotEqual(newValue, existingSettings.value);
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = existingSettings.key
});
Assert.IsTrue(getSettingsResponse.Success);
Assert.AreEqual(newValue, getSettingsResponse.Value);
}
[Test]
public void PutSettings_WhenKeyExistsAndValueIsEmpty_IsNotSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
string newValue = string.Empty;
PutSettingResponse putSettingsResponse = settingsStore.PutSetting(new PutSettingRequest
{
Key = existingSettings.key,
Value = newValue,
});
Assert.IsFalse(putSettingsResponse.Success);
Assert.AreSame(putSettingsResponse.ErrorCode, ErrorCode.InvalidParameters);
}
[Test]
public void ClearSetting_WhenPassedKeyExists_IsSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
ClearSettingResponse clearResponse = settingsStore.ClearSetting(new ClearSettingRequest() { Key = existingSettings.key });
Assert.True(clearResponse.Success);
GetSettingResponse getSettingsResponse = settingsStore.GetSetting(new GetSettingRequest
{
Key = existingSettings.key
});
Assert.IsFalse(getSettingsResponse.Success);
Assert.IsNotEmpty(getSettingsResponse.ErrorCode);
Assert.AreSame(getSettingsResponse.ErrorCode, ErrorCode.NoSettingsKeyFound);
}
[Test]
public void ClearSetting_WhenPassedKeyDoesNotExists_IsNotSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
ClearSettingResponse clearResponse = settingsStore.ClearSetting(new ClearSettingRequest()
{
Key = Guid.NewGuid().ToString()
});
Assert.IsTrue(clearResponse.Success);
}
[Test]
public void ClearSetting_WhenEmptyKeyWasPassed_IsNotSuccessful()
{
(string key, string value) existingSettings = EnsureValidSettingsAreCreated();
SettingsStore settingsStore = Factory.CreateSettingsStore();
ClearSettingResponse clearResponse = settingsStore.ClearSetting(new ClearSettingRequest()
{
Key = string.Empty
});
Assert.IsFalse(clearResponse.Success);
Assert.IsNotEmpty(clearResponse.ErrorCode);
Assert.AreSame(clearResponse.ErrorCode, ErrorCode.InvalidParameters);
}
[Test]
public void ClearSetting_WhenFileDoesNotExist_IsNotSuccessful()
{
SettingsStore settingsStore = Factory.CreateSettingsStore();
ClearSettingResponse clearResponse = settingsStore.ClearSetting(new ClearSettingRequest()
{
Key = Guid.NewGuid().ToString()
});
Assert.IsFalse(clearResponse.Success);
Assert.IsNotEmpty(clearResponse.ErrorCode);
Assert.AreSame(clearResponse.ErrorCode, ErrorCode.NoSettingsFileFound);
}
private (string key, string value) EnsureValidSettingsAreCreated(string key = default, string value = default)
{
(bool isSucceed, string key, string value) createdSettings = Factory.GetCreatedSettings(key, value);
Assert.IsTrue(createdSettings.isSucceed);
return (createdSettings.key, createdSettings.value);
}
}
}
| 332 |
amazon-gamelift-plugin-unity | aws | C# | // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
using System.Threading.Tasks;
using Amazon.CognitoIdentityProvider;
using Amazon.CognitoIdentityProvider.Model;
using AmazonGameLiftPlugin.Core.Shared;
using AmazonGameLiftPlugin.Core.UserIdentityManagement;
using Moq;
using NUnit.Framework;
namespace AmazonGameLiftPlugin.Core.Tests.UserIdentityManagement
{
[TestFixture]
public class UserIdentityTests
{
[Test]
public void SignUp_WhenIdentityProviderReturnSuccess_IsSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string clientId = "testClientId";
string password = "testPassword";
string username = "testUsername";
mock.Setup(x => x.SignUp(
It.Is<AmazonGameLiftPlugin.Core.UserIdentityManagement.Models.SignUpRequest>(
p => p.ClientId == clientId &&
p.Password == password &&
p.Username == username
)
)).Returns(new Core.UserIdentityManagement.Models.SignUpResponse());
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.SignUpResponse response =
sut.SignUp(new Core.UserIdentityManagement.Models.SignUpRequest
{
ClientId = clientId,
Password = password,
Username = username
});
mock.Verify();
Assert.IsTrue(response.Success);
}
[Test]
public void SignUp_WhenIdentityProviderThrows_IsNotSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string clientId = "testClientId";
string password = "testPassword";
string username = "testUsername";
mock.Setup(x => x.SignUp(
It.Is<AmazonGameLiftPlugin.Core.UserIdentityManagement.Models.SignUpRequest>(
p => p.ClientId == clientId &&
p.Password == password &&
p.Username == username
)
)).Throws(new AmazonCognitoIdentityProviderException("Failure"));
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.SignUpResponse response =
sut.SignUp(new Core.UserIdentityManagement.Models.SignUpRequest
{
ClientId = clientId,
Password = password,
Username = username
});
mock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
Assert.AreEqual("Failure", response.ErrorMessage);
}
[Test]
public void ConfirmSignUp_WhenIdentityProviderReturnSuccess_IsSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string clientId = "testClientId";
string code = "testCode";
string username = "testUsername";
mock.Setup(x => x.ConfirmSignUp(
It.Is<Core.UserIdentityManagement.Models.ConfirmSignUpRequest>(
p => p.ClientId == clientId &&
p.ConfirmationCode == code &&
p.Username == username
)
)).Returns(new Core.UserIdentityManagement.Models.ConfirmSignUpResponse());
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.ConfirmSignUpResponse response =
sut.ConfirmSignUp(new Core.UserIdentityManagement.Models.ConfirmSignUpRequest
{
ClientId = clientId,
ConfirmationCode = code,
Username = username
});
mock.Verify();
Assert.IsTrue(response.Success);
}
[Test]
public void ConfirmSignUp_WhenIdentityProviderThrows_IsNotSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string clientId = "testClientId";
string code = "testCode";
string username = "testUsername";
mock.Setup(x => x.ConfirmSignUp(
It.Is<Core.UserIdentityManagement.Models.ConfirmSignUpRequest>(
p => p.ClientId == clientId &&
p.ConfirmationCode == code &&
p.Username == username
)
)).Throws(new AmazonCognitoIdentityProviderException("Failure"));
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.ConfirmSignUpResponse response =
sut.ConfirmSignUp(new Core.UserIdentityManagement.Models.ConfirmSignUpRequest
{
ClientId = clientId,
ConfirmationCode = code,
Username = username
});
mock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
Assert.AreEqual("Failure", response.ErrorMessage);
}
[Test]
public void SignIn_WhenIdentityProviderReturnSuccess_IsSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string clientId = "testClientId";
string password = "testPassword";
string username = "testUsername";
mock.Setup(x => x.InitiateAuth(It.Is<InitiateAuthRequest>
(
p => p.ClientId == clientId &&
p.AuthFlow == AuthFlowType.USER_PASSWORD_AUTH &&
p.AuthParameters.ContainsValue(username) &&
p.AuthParameters.ContainsValue(password)
)
)).Returns(new InitiateAuthResponse
{
AuthenticationResult = new AuthenticationResultType
{
AccessToken = "testToken",
RefreshToken = "testRefreshToken",
IdToken = "testIdToken"
}
});
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.SignInResponse response =
sut.SignIn(new Core.UserIdentityManagement.Models.SignInRequest
{
ClientId = clientId,
Password = password,
Username = username
});
mock.Verify();
Assert.IsTrue(response.Success);
Assert.AreEqual("testToken", response.AccessToken);
Assert.AreEqual("testRefreshToken", response.RefreshToken);
Assert.AreEqual("testIdToken", response.IdToken);
}
[Test]
public void SignIn_WhenIdentityProviderThrows_IsNotSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string clientId = "testClientId";
string password = "testPassword";
string username = "testUsername";
mock.Setup(x => x.InitiateAuth(It.Is<InitiateAuthRequest>
(
p => p.ClientId == clientId &&
p.AuthFlow == AuthFlowType.USER_PASSWORD_AUTH &&
p.AuthParameters.ContainsValue(username) &&
p.AuthParameters.ContainsValue(password)
)
)).Throws(new UserNotConfirmedException("User is not Confirmed."));
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.SignInResponse response =
sut.SignIn(new Core.UserIdentityManagement.Models.SignInRequest
{
ClientId = clientId,
Password = password,
Username = username
});
mock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UserNotConfirmed, response.ErrorCode);
Assert.AreEqual("User is not Confirmed.", response.ErrorMessage);
}
[Test]
public void SignOut_WhenIdentityProviderReturnSuccess_IsSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string accessToken = "testAccessToken";
mock.Setup(x => x.SignOut(It.Is<GlobalSignOutRequest>
(
p => p.AccessToken == accessToken
))).Returns(new GlobalSignOutResponse());
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.SignOutResponse response =
sut.SignOut(new Core.UserIdentityManagement.Models.SignOutRequest
{
AccessToken = accessToken
});
mock.Verify();
Assert.IsTrue(response.Success);
}
[Test]
public void SignOut_WhenIdentityProviderThrows_IsNotSuccessful()
{
var mock = new Mock<IAmazonCognitoIdentityWrapper>();
string accessToken = "testAccessToken";
mock.Setup(x => x.SignOut(It.Is<GlobalSignOutRequest>
(
p => p.AccessToken == accessToken
)))
.Throws(new AmazonCognitoIdentityProviderException("Failure"));
var sut = new UserIdentity(mock.Object);
Core.UserIdentityManagement.Models.SignOutResponse response =
sut.SignOut(new Core.UserIdentityManagement.Models.SignOutRequest
{
AccessToken = accessToken
});
mock.Verify();
Assert.IsFalse(response.Success);
Assert.AreEqual(ErrorCode.UnknownError, response.ErrorCode);
Assert.AreEqual("Failure", response.ErrorMessage);
}
}
}
| 274 |
amazon-neptune-gremlin-dotnet-sigv4 | aws | C# | using System;
using System.Collections.Generic;
using System.Net.WebSockets;
using System.Linq;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using Gremlin.Net;
using Gremlin.Net.Driver;
using Gremlin.Net.Driver.Remote;
using Gremlin.Net.Process;
using Gremlin.Net.Process.Traversal;
using Gremlin.Net.Structure;
using static Gremlin.Net.Process.Traversal.AnonymousTraversalSource;
using static Gremlin.Net.Process.Traversal.__;
using static Gremlin.Net.Process.Traversal.P;
using static Gremlin.Net.Process.Traversal.Order;
using static Gremlin.Net.Process.Traversal.Operator;
using static Gremlin.Net.Process.Traversal.Pop;
using static Gremlin.Net.Process.Traversal.Scope;
using static Gremlin.Net.Process.Traversal.TextP;
using static Gremlin.Net.Process.Traversal.Column;
using static Gremlin.Net.Process.Traversal.Direction;
using static Gremlin.Net.Process.Traversal.T;
using Amazon.Runtime.CredentialManagement;
using Amazon.Runtime;
using Amazon;
using Amazon.Util;
using Amazon.Neptune.Gremlin.Driver;
namespace NeptuneExample
{
class Program
{
static void Main(string[] args)
{
/*
Include your Neptune endpoint and port below.
*/
var neptune_host = "neptune-endpoint"; // ex: mycluster.cluster.us-east-1.neptune.amazonaws.com
var neptune_port = 8182;
var gremlinServer = new GremlinServer(neptune_host, neptune_port);
var gremlinClient = new GremlinClient(gremlinServer, webSocketConfiguration: new SigV4RequestSigner().signRequest(neptune_host, neptune_port));
var remoteConnection = new DriverRemoteConnection(gremlinClient);
var g = Traversal().WithRemote(remoteConnection);
/* Example code to pull the first 5 vertices in a graph. */
Console.WriteLine("Get List of Node Labels:");
Int32 limitValue = 5;
var output = g.V().Limit<Vertex>(limitValue).ToList();
foreach(var item in output) {
Console.WriteLine(item);
}
}
}
}
| 62 |
amazon-neptune-gremlin-dotnet-sigv4 | aws | C# | using System;
using System.Collections.Generic;
using System.Net.WebSockets;
using System.Linq;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Web;
using Amazon.Runtime;
using Amazon;
namespace Amazon.Neptune.Gremlin.Driver
{
public class SigV4RequestSigner
{
private readonly string _access_key;
private readonly string _secret_key;
private readonly string _token;
private readonly string _region;
private readonly SHA256 _sha256;
private const string algorithm = "AWS4-HMAC-SHA256";
/* Constructor
*
*
*
*
*/
public SigV4RequestSigner()
{
ImmutableCredentials awsCredentials = FallbackCredentialsFactory.GetCredentials().GetCredentials();
RegionEndpoint region = FallbackRegionFactory.GetRegionEndpoint();
_access_key = awsCredentials.AccessKey;
_secret_key = awsCredentials.SecretKey;
_token = awsCredentials.Token;
_region = region.SystemName; //ex: us-east-1
_sha256 = SHA256.Create();
}
/******************** AWS SIGNING FUNCTIONS *********************/
private string Hash(byte[] bytesToHash)
{
var result = _sha256.ComputeHash(bytesToHash);
return ToHexString(result);
}
private static byte[] HmacSHA256(byte[] key, string data)
{
var hashAlgorithm = new HMACSHA256(key);
return hashAlgorithm.ComputeHash(Encoding.UTF8.GetBytes(data));
}
private static byte[] GetSignatureKey(string key, string dateStamp, string regionName, string serviceName)
{
byte[] kSecret = Encoding.UTF8.GetBytes("AWS4" + key);
byte[] kDate = HmacSHA256(kSecret, dateStamp);
byte[] kRegion = HmacSHA256(kDate, regionName);
byte[] kService = HmacSHA256(kRegion, serviceName);
byte[] kSigning = HmacSHA256(kService, "aws4_request");
return kSigning;
}
private static string ToHexString(byte[] array)
{
var hex = new StringBuilder(array.Length * 2);
foreach (byte b in array) {
hex.AppendFormat("{0:x2}", b);
}
return hex.ToString();
}
public Action<ClientWebSocketOptions> signRequest(string hostname, int port)
{
var neptune_endpoint = hostname + ":" + port;
var request = new HttpRequestMessage {
Method = HttpMethod.Get,
RequestUri = new Uri("https://" + neptune_endpoint + "/gremlin")
};
var signedrequest = this.Sign(request, "neptune-db", _region);
return new Action<ClientWebSocketOptions>(options => {
options.SetRequestHeader("host", neptune_endpoint);
options.SetRequestHeader("x-amz-date", signedrequest.Headers.GetValues("x-amz-date").FirstOrDefault());
options.SetRequestHeader("Authorization", signedrequest.Headers.GetValues("Authorization").FirstOrDefault());
});
}
public HttpRequestMessage Sign(HttpRequestMessage request, string service, string region, string sessionToken = null)
{
var amzdate = DateTimeOffset.UtcNow.ToString("yyyyMMddTHHmmssZ");
var datestamp = DateTimeOffset.UtcNow.ToString("yyyyMMdd");
var canonical_request = new StringBuilder();
var canonicalQueryParams = "";
var signedHeadersList = new List<string>();
var signed_headers = "";
var content = new byte[0];
var payload_hash = Hash(content);
var credential_scope = $"{datestamp}/{region}/{service}/aws4_request";
if (string.IsNullOrEmpty(service)) {
throw new ArgumentOutOfRangeException(nameof(service), service, "Not a valid service.");
}
if (string.IsNullOrEmpty(region)) {
throw new ArgumentOutOfRangeException(nameof(region), region, "Not a valid region.");
}
if (request == null) {
throw new ArgumentNullException(nameof(request));
}
if (request.Headers.Host == null) {
request.Headers.Host = request.RequestUri.Host + ":" + request.RequestUri.Port;
}
if (sessionToken != null ) {
request.Headers.Add("x-amz-security-token",sessionToken);
}
request.Headers.Add("x-amz-date", amzdate);
canonicalQueryParams = GetCanonicalQueryParams(request);
canonical_request.Append(request.Method + "\n");
canonical_request.Append(request.RequestUri.AbsolutePath + "\n");
canonical_request.Append(canonicalQueryParams + "\n");
foreach (var header in request.Headers.OrderBy(a => a.Key.ToLowerInvariant()))
{
canonical_request.Append(header.Key.ToLowerInvariant());
canonical_request.Append(":");
canonical_request.Append(string.Join(",", header.Value.Select(s => s.Trim())));
canonical_request.Append("\n");
signedHeadersList.Add(header.Key.ToLowerInvariant());
}
canonical_request.Append("\n");
signed_headers = string.Join(";", signedHeadersList);
canonical_request.Append(signed_headers + "\n");
canonical_request.Append(payload_hash);
var string_to_sign = $"{algorithm}\n{amzdate}\n{credential_scope}\n" + Hash(Encoding.UTF8.GetBytes(canonical_request.ToString()));
var signing_key = GetSignatureKey(_secret_key, datestamp, region, service);
var signature = ToHexString(HmacSHA256(signing_key, string_to_sign));
request.Headers.TryAddWithoutValidation("Authorization", $"{algorithm} Credential={_access_key}/{credential_scope}, SignedHeaders={signed_headers}, Signature={signature}");
return request;
}
private static string GetCanonicalQueryParams(HttpRequestMessage request)
{
var querystring = HttpUtility.ParseQueryString(request.RequestUri.Query);
var keys = querystring.AllKeys.OrderBy(a => a).ToArray();
// Query params must be escaped in upper case (i.e. "%2C", not "%2c").
var queryParams = keys.Select(key => $"{key}={Uri.EscapeDataString(querystring[key])}");
var canonicalQueryParams = string.Join("&", queryParams);
return canonicalQueryParams;
}
}
}
| 166 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Text;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// Exception thrown by the SDK for errors that occur within the SDK for crypto operations.
/// </summary>
#if !PCL && !NETSTANDARD
[Serializable]
#endif
public class AmazonCryptoException : Exception
{
public AmazonCryptoException(string message) : base(message) { }
public AmazonCryptoException(string message, Exception innerException) : base(message, innerException) { }
#if !PCL && !NETSTANDARD
/// <summary>
/// Constructs a new instance of the AmazonCryptoException class with serialized data.
/// </summary>
/// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
/// <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception>
/// <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception>
protected AmazonCryptoException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
: base(info, context)
{
}
#endif
}
}
| 48 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Amazon.S3;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// AmazonS3CryptoConfiguration allows customers
/// to configure AmazonS3EncryptionClient
/// </summary>
public class AmazonS3CryptoConfiguration: AmazonS3CryptoConfigurationBase
{
}
} | 31 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Amazon.S3;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// Base class for AmazonS3CryptoConfiguration configs
/// Encapsulates common properties and methods of the AmazonS3CryptoConfiguration configurations
/// </summary>
public abstract class AmazonS3CryptoConfigurationBase: AmazonS3Config
{
/// <summary>
/// Gets and sets the StorageMode property. This determines if the crypto metadata is stored as metadata on the object or as a separate object in S3.
/// The default is ObjectMetadata.
/// </summary>
public CryptoStorageMode StorageMode { get; set; }
/// <summary>
/// Default Constructor.
/// </summary>
public AmazonS3CryptoConfigurationBase()
{
// By default, store encryption info in metadata
StorageMode = CryptoStorageMode.ObjectMetadata;
}
}
} | 45 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Amazon.Runtime.Internal.Util;
using Amazon.S3;
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.S3.Model;
using Amazon.Runtime.Internal;
using Amazon.S3;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// AmazonS3CryptoConfigurationV2 allows customers
/// to set storage mode for encryption credentials
/// for AmazonS3EncryptionClientV2
/// </summary>
public class AmazonS3CryptoConfigurationV2: AmazonS3CryptoConfigurationBase
{
private readonly ILogger _logger;
private SecurityProfile _securityProfile;
/// <summary>
/// Determines enabled key wrap and content encryption schemas
/// The default is V2.
/// </summary>
public SecurityProfile SecurityProfile
{
get => _securityProfile;
set
{
_securityProfile = value;
if (_securityProfile == SecurityProfile.V2AndLegacy)
{
_logger.InfoFormat($"The {nameof(AmazonS3CryptoConfigurationV2)} is configured to read encrypted data with legacy encryption modes." +
" If you don't have objects encrypted with these legacy modes, you should disable support for them to enhance security." +
$" See {EncryptionUtils.SDKEncryptionDocsUrl}");
}
}
}
/// <summary>
/// Default Constructor.
/// </summary>
public AmazonS3CryptoConfigurationV2(SecurityProfile securityProfile)
{
_logger = Logger.GetLogger(GetType());
SecurityProfile = securityProfile;
}
}
} | 71 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Extensions.S3.Encryption.Internal;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// This class extends the AmazonS3Client and provides client side encryption when reading or writing S3 objects.
/// </summary>
[Obsolete("This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.")]
public partial class AmazonS3EncryptionClient : AmazonS3EncryptionClientBase
{
///<inheritdoc/>
public AmazonS3EncryptionClient(EncryptionMaterials materials) : base(materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(RegionEndpoint region, EncryptionMaterials materials)
: base(region, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
: base(config, materials)
{
}
///<inheritdoc/>
public AmazonS3EncryptionClient(AWSCredentials credentials, EncryptionMaterials materials)
: base(credentials, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(AWSCredentials credentials, RegionEndpoint region, EncryptionMaterials materials)
: base(credentials, region, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(AWSCredentials credentials, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
: base(credentials, config, materials)
{
}
///<inheritdoc/>
public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, EncryptionMaterials materials)
: base(awsAccessKeyId, awsSecretAccessKey, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region, EncryptionMaterials materials)
: base(awsAccessKeyId, awsSecretAccessKey, region, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
: base(awsAccessKeyId, awsSecretAccessKey, config, materials)
{
}
///<inheritdoc/>
public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, EncryptionMaterials materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region, EncryptionMaterials materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, region, materials)
{
S3CryptoConfig = new AmazonS3CryptoConfiguration();
}
///<inheritdoc/>
public AmazonS3EncryptionClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, config, materials)
{
}
///<inheritdoc/>
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
base.CustomizeRuntimePipeline(pipeline);
pipeline.AddHandlerBefore<Amazon.Runtime.Internal.Marshaller>(new SetupEncryptionHandlerV1(this));
pipeline.AddHandlerAfter<Amazon.Runtime.Internal.Marshaller>(new UserAgentHandler("S3CryptoV1n"));
pipeline.AddHandlerBefore<Amazon.S3.Internal.AmazonS3ResponseHandler>(new SetupDecryptionHandlerV1(this));
}
}
}
| 119 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Runtime;
using Amazon.Runtime.SharedInterfaces;
using Amazon.Runtime.SharedInterfaces.Internal;
using Amazon.S3.Internal;
using Amazon.S3.Model;
using System.Collections.Generic;
using Amazon.KeyManagementService;
using Amazon.S3;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// Base class for AmazonS3Encryption clients
/// Encapsulates common properties and methods of the encryption clients
/// </summary>
public abstract class AmazonS3EncryptionClientBase : AmazonS3Client, IAmazonS3Encryption
{
private IAmazonKeyManagementService kmsClient;
private readonly object kmsClientLock = new object();
internal EncryptionMaterialsBase EncryptionMaterials
{
get;
private set;
}
internal IAmazonKeyManagementService KMSClient
{
get
{
if (kmsClient == null)
{
lock (kmsClientLock)
{
if (kmsClient == null)
{
var kmsConfig = new AmazonKeyManagementServiceConfig
{
RegionEndpoint = this.Config.RegionEndpoint,
Timeout = this.Config.Timeout
};
var proxySettings = this.Config.GetWebProxy();
if(proxySettings != null)
{
kmsConfig.SetWebProxy(proxySettings);
}
kmsClient = new AmazonKeyManagementServiceClient(Credentials, kmsConfig);
}
}
}
return kmsClient;
}
}
private AmazonS3Client s3ClientForInstructionFile;
internal AmazonS3Client S3ClientForInstructionFile
{
get
{
if (s3ClientForInstructionFile == null)
{
s3ClientForInstructionFile = new AmazonS3Client(Credentials, S3CryptoConfig);
}
return s3ClientForInstructionFile;
}
}
internal AmazonS3CryptoConfigurationBase S3CryptoConfig { get; set; }
#if BCL35
internal readonly Amazon.Extensions.S3.Encryption.Utils.ConcurrentDictionary<string, UploadPartEncryptionContext> CurrentMultiPartUploadKeys =
new Amazon.Extensions.S3.Encryption.Utils.ConcurrentDictionary<string, UploadPartEncryptionContext>();
internal readonly Amazon.Extensions.S3.Encryption.Utils.ConcurrentDictionary<InitiateMultipartUploadRequest, UploadPartEncryptionContext> AllMultiPartUploadRequestContexts =
new Amazon.Extensions.S3.Encryption.Utils.ConcurrentDictionary<InitiateMultipartUploadRequest, UploadPartEncryptionContext>();
#else
internal readonly System.Collections.Concurrent.ConcurrentDictionary<string, UploadPartEncryptionContext> CurrentMultiPartUploadKeys =
new System.Collections.Concurrent.ConcurrentDictionary<string, UploadPartEncryptionContext>();
internal readonly System.Collections.Concurrent.ConcurrentDictionary<InitiateMultipartUploadRequest, UploadPartEncryptionContext> AllMultiPartUploadRequestContexts =
new System.Collections.Concurrent.ConcurrentDictionary<InitiateMultipartUploadRequest, UploadPartEncryptionContext>();
#endif
internal const string S3CryptoStream = "S3-Crypto-Stream";
#region Constructors
/// <summary>
/// Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(EncryptionMaterialsBase materials)
: base()
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="region">
/// The region to connect.
/// </param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(RegionEndpoint region, EncryptionMaterialsBase materials)
: base(region)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with the Encryption materials,
/// AmazonS3 CryptoConfiguration object and credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
/// <code>
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
/// </code>
///
/// </summary>
/// <param name="config">
/// The AmazonS3EncryptionClient CryptoConfiguration Object
/// </param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)
: base(config)
{
this.EncryptionMaterials = materials;
S3CryptoConfig = config;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials.
/// </summary>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
/// <param name="credentials">AWS Credentials</param>
public AmazonS3EncryptionClientBase(AWSCredentials credentials, EncryptionMaterialsBase materials)
: base(credentials)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="region">The region to connect.</param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(AWSCredentials credentials, RegionEndpoint region, EncryptionMaterialsBase materials)
: base(credentials, region)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfigurationBase Configuration object
/// and Encryption materials
/// </summary>
/// <param name="credentials">AWS Credentials</param>
/// <param name="config">The AmazonS3EncryptionClient CryptoConfiguration Object</param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(AWSCredentials credentials, AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)
: base(credentials, config)
{
this.EncryptionMaterials = materials;
S3CryptoConfig = config;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Access Key ID,
/// AWS Secret Key and Encryption materials
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="materials">The encryption materials to be used to encrypt and decrypt envelope key.</param>
public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, EncryptionMaterialsBase materials)
: base(awsAccessKeyId, awsSecretAccessKey)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Access Key ID,
/// AWS Secret Key, Region and Encryption materials
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="region">The region to connect.</param>
/// <param name="materials">The encryption materials to be used to encrypt and decrypt envelope key.</param>
public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region, EncryptionMaterialsBase materials)
: base(awsAccessKeyId, awsSecretAccessKey, region)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key,
/// AmazonS3 CryptoConfiguration object and Encryption materials.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="config">The AmazonS3EncryptionClient CryptoConfiguration Object</param>
/// <param name="materials">The encryption materials to be used to encrypt and decrypt envelope key.</param>
public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)
: base(awsAccessKeyId, awsSecretAccessKey, config)
{
this.EncryptionMaterials = materials;
S3CryptoConfig = config;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key,
/// SessionToken and Encryption materials.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, EncryptionMaterialsBase materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key,
/// SessionToken, Region and Encryption materials.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="region">The region to connect.</param>
/// <param name="materials">The encryption materials to be used to encrypt and decrypt envelope key.</param>
public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region, EncryptionMaterialsBase materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, region)
{
this.EncryptionMaterials = materials;
}
/// <summary>
/// Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken
/// AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials.
/// </summary>
/// <param name="awsAccessKeyId">AWS Access Key ID</param>
/// <param name="awsSecretAccessKey">AWS Secret Access Key</param>
/// <param name="awsSessionToken">AWS Session Token</param>
/// <param name="config">The AmazonS3EncryptionClient CryptoConfiguration Object</param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt envelope key.
/// </param>
public AmazonS3EncryptionClientBase(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3CryptoConfigurationBase config, EncryptionMaterialsBase materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, config)
{
this.EncryptionMaterials = materials;
S3CryptoConfig = config;
}
#endregion
/// <summary>
/// Turn off response logging because it will interfere with decrypt of the data coming back from S3.
/// </summary>
protected override bool SupportResponseLogging
{
get
{
return false;
}
}
/// <summary>
/// Dispose this instance
/// </summary>
/// <param name="disposing"></param>
protected override void Dispose(bool disposing)
{
lock (kmsClientLock)
{
if (kmsClient != null)
{
kmsClient.Dispose();
kmsClient = null;
}
}
base.Dispose(disposing);
}
}
}
| 347 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using Amazon.Extensions.S3.Encryption.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.S3.Model;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// This class extends the AmazonS3Client and implements IAmazonS3Encryption
/// Provides client side encryption when reading or writing S3 objects.
/// Supported content ciphers:
/// AES/GCM - Encryption and decryption (Encrypted block size can be bigger than the input block size)
/// AES/CBC - Decryption only
/// </summary>
public partial class AmazonS3EncryptionClientV2 : AmazonS3EncryptionClientBase
{
///<inheritdoc/>
public AmazonS3EncryptionClientV2(AmazonS3CryptoConfigurationV2 config, EncryptionMaterialsV2 materials)
: base(config, materials)
{
}
///<inheritdoc/>
public AmazonS3EncryptionClientV2(AWSCredentials credentials, AmazonS3CryptoConfigurationV2 config, EncryptionMaterialsV2 materials)
: base(credentials, config, materials)
{
}
///<inheritdoc/>
public AmazonS3EncryptionClientV2(string awsAccessKeyId, string awsSecretAccessKey, AmazonS3CryptoConfigurationV2 config, EncryptionMaterialsV2 materials)
: base(awsAccessKeyId, awsSecretAccessKey, config, materials)
{
}
///<inheritdoc/>
public AmazonS3EncryptionClientV2(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3CryptoConfigurationV2 config, EncryptionMaterialsV2 materials)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, config, materials)
{
}
///<inheritdoc/>
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
base.CustomizeRuntimePipeline(pipeline);
pipeline.AddHandlerBefore<Amazon.Runtime.Internal.Marshaller>(new SetupEncryptionHandlerV2(this));
pipeline.AddHandlerAfter<Amazon.Runtime.Internal.Marshaller>(new UserAgentHandler("S3CryptoV2"));
pipeline.AddHandlerBefore<Amazon.S3.Internal.AmazonS3ResponseHandler>(new SetupDecryptionHandlerV2(this));
}
#if AWS_ASYNC_API
/// <summary>
/// Retrieves objects from Amazon S3. To use <c>GET</c>, you must have <c>READ</c>
/// access to the object. If you grant <c>READ</c> access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
/// <para>
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// <c>sample.jpg</c>, you can name it <c>photos/2006/February/sample.jpg</c>.
/// </para>
///
/// <para>
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the <c>GET</c> operation. For a virtual hosted-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c>, specify the resource
/// as <c>/photos/2006/February/sample.jpg</c>. For a path-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c> in the bucket
/// named <c>examplebucket</c>, specify the resource as <c>/examplebucket/photos/2006/February/sample.jpg</c>.
/// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP
/// Host Header Bucket Specification</a>.
/// </para>
///
/// <para>
/// To distribute large files to many people, you can save bandwidth costs by using BitTorrent.
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Amazon
/// S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.
/// </para>
///
/// <para>
/// If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage
/// classes, before you can retrieve the object you must first restore a copy using .
/// Otherwise, this operation returns an <c>InvalidObjectStateError</c> error. For
/// information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
/// Archived Objects</a>.
/// </para>
///
/// <para>
/// Encryption request headers, like <c>x-amz-server-side-encryption</c>, should
/// not be sent for GET requests if your object uses server-side encryption with CMKs
/// stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
/// keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
/// BadRequest error.
/// </para>
///
/// <para>
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
/// </para>
/// <ul> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-algorithm
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key-MD5
/// </para>
/// </li> </ul>
/// <para>
/// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
/// Encryption (Using Customer-Provided Encryption Keys)</a>.
/// </para>
///
/// <para>
/// Assuming you have permission to read object tags (permission for the <c>s3:GetObjectVersionTagging</c>
/// action), the response also returns the <c>x-amz-tagging-count</c> header that
/// provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a>
/// to retrieve the tag set associated with an object.
/// </para>
///
/// <para>
/// <b>Permissions</b>
/// </para>
///
/// <para>
/// You need the <c>s3:GetObject</c> permission for this operation. For more information,
/// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
/// Permissions in a Policy</a>. If the object you request does not exist, the error Amazon
/// S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission.
/// </para>
/// <ul> <li>
/// <para>
/// If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 will
/// return an HTTP status code 404 ("no such key") error.
/// </para>
/// </li> <li>
/// <para>
/// If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 will return
/// an HTTP status code 403 ("access denied") error.
/// </para>
/// </li> </ul>
/// <para>
/// <b>Versioning</b>
/// </para>
///
/// <para>
/// By default, the GET operation returns the current version of an object. To return
/// a different version, use the <c>versionId</c> subresource.
/// </para>
/// <note>
/// <para>
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes <c>x-amz-delete-marker: true</c> in the response.
/// </para>
/// </note>
/// <para>
/// For more information about versioning, see <a>PutBucketVersioning</a>.
/// </para>
///
/// <para>
/// <b>Overriding Response Header Values</b>
/// </para>
///
/// <para>
/// There are times when you want to override certain response header values in a GET
/// response. For example, you might override the Content-Disposition response header
/// value in your GET request.
/// </para>
///
/// <para>
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are <c>Content-Type</c>,
/// <c>Content-Language</c>, <c>Expires</c>, <c>Cache-Control</c>, <c>Content-Disposition</c>,
/// and <c>Content-Encoding</c>. To override these header values in the GET response,
/// you use the following request parameters.
/// </para>
/// <note>
/// <para>
/// You must sign the request, either using an Authorization header or a presigned URL,
/// when using these parameters. They cannot be used with an unsigned (anonymous) request.
/// </para>
/// </note> <ul> <li>
/// <para>
/// <c>response-content-type</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-language</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-expires</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-cache-control</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-disposition</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-encoding</c>
/// </para>
/// </li> </ul>
/// <para>
/// <b>Additional Considerations about Request Headers</b>
/// </para>
///
/// <para>
/// If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers
/// are present in the request as follows: <c>If-Match</c> condition evaluates to
/// <c>true</c>, and; <c>If-Unmodified-Since</c> condition evaluates to <c>false</c>;
/// then, S3 returns 200 OK and the data requested.
/// </para>
///
/// <para>
/// If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers
/// are present in the request as follows:<c> If-None-Match</c> condition evaluates
/// to <c>false</c>, and; <c>If-Modified-Since</c> condition evaluates to
/// <c>true</c>; then, S3 returns 304 Not Modified response code.
/// </para>
///
/// <para>
/// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC
/// 7232</a>.
/// </para>
///
/// <para>
/// The following operations are related to <c>GetObject</c>:
/// </para>
/// <ul> <li>
/// <para>
/// <a>ListBuckets</a>
/// </para>
/// </li> <li>
/// <para>
/// <a>GetObjectAcl</a>
/// </para>
/// </li> </ul>
/// </summary>
/// <remarks>
/// When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data.
/// This is to verify that the object has not been modified since it was encrypted.
/// </remarks>
/// <param name="request">Container for the necessary parameters to execute the GetObject service method.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The response from the GetObject service method, as returned by S3.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso>
public override System.Threading.Tasks.Task<GetObjectResponse> GetObjectAsync(GetObjectRequest request,
System.Threading.CancellationToken cancellationToken = new System.Threading.CancellationToken())
{
return base.GetObjectAsync(request, cancellationToken);
}
/// <summary>
/// Retrieves objects from Amazon S3. To use <c>GET</c>, you must have <c>READ</c>
/// access to the object. If you grant <c>READ</c> access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
/// <para>
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// <c>sample.jpg</c>, you can name it <c>photos/2006/February/sample.jpg</c>.
/// </para>
///
/// <para>
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the <c>GET</c> operation. For a virtual hosted-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c>, specify the resource
/// as <c>/photos/2006/February/sample.jpg</c>. For a path-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c> in the bucket
/// named <c>examplebucket</c>, specify the resource as <c>/examplebucket/photos/2006/February/sample.jpg</c>.
/// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP
/// Host Header Bucket Specification</a>.
/// </para>
///
/// <para>
/// To distribute large files to many people, you can save bandwidth costs by using BitTorrent.
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Amazon
/// S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.
/// </para>
///
/// <para>
/// If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage
/// classes, before you can retrieve the object you must first restore a copy using .
/// Otherwise, this operation returns an <c>InvalidObjectStateError</c> error. For
/// information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
/// Archived Objects</a>.
/// </para>
///
/// <para>
/// Encryption request headers, like <c>x-amz-server-side-encryption</c>, should
/// not be sent for GET requests if your object uses server-side encryption with CMKs
/// stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
/// keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
/// BadRequest error.
/// </para>
///
/// <para>
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
/// </para>
/// <ul> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-algorithm
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key-MD5
/// </para>
/// </li> </ul>
/// <para>
/// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
/// Encryption (Using Customer-Provided Encryption Keys)</a>.
/// </para>
///
/// <para>
/// Assuming you have permission to read object tags (permission for the <c>s3:GetObjectVersionTagging</c>
/// action), the response also returns the <c>x-amz-tagging-count</c> header that
/// provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a>
/// to retrieve the tag set associated with an object.
/// </para>
///
/// <para>
/// <b>Permissions</b>
/// </para>
///
/// <para>
/// You need the <c>s3:GetObject</c> permission for this operation. For more information,
/// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
/// Permissions in a Policy</a>. If the object you request does not exist, the error Amazon
/// S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission.
/// </para>
/// <ul> <li>
/// <para>
/// If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 will
/// return an HTTP status code 404 ("no such key") error.
/// </para>
/// </li> <li>
/// <para>
/// If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 will return
/// an HTTP status code 403 ("access denied") error.
/// </para>
/// </li> </ul>
/// <para>
/// <b>Versioning</b>
/// </para>
///
/// <para>
/// By default, the GET operation returns the current version of an object. To return
/// a different version, use the <c>versionId</c> subresource.
/// </para>
/// <note>
/// <para>
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes <c>x-amz-delete-marker: true</c> in the response.
/// </para>
/// </note>
/// <para>
/// For more information about versioning, see <a>PutBucketVersioning</a>.
/// </para>
///
/// <para>
/// <b>Overriding Response Header Values</b>
/// </para>
///
/// <para>
/// There are times when you want to override certain response header values in a GET
/// response. For example, you might override the Content-Disposition response header
/// value in your GET request.
/// </para>
///
/// <para>
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are <c>Content-Type</c>,
/// <c>Content-Language</c>, <c>Expires</c>, <c>Cache-Control</c>, <c>Content-Disposition</c>,
/// and <c>Content-Encoding</c>. To override these header values in the GET response,
/// you use the following request parameters.
/// </para>
/// <note>
/// <para>
/// You must sign the request, either using an Authorization header or a presigned URL,
/// when using these parameters. They cannot be used with an unsigned (anonymous) request.
/// </para>
/// </note> <ul> <li>
/// <para>
/// <c>response-content-type</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-language</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-expires</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-cache-control</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-disposition</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-encoding</c>
/// </para>
/// </li> </ul>
/// <para>
/// <b>Additional Considerations about Request Headers</b>
/// </para>
///
/// <para>
/// If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers
/// are present in the request as follows: <c>If-Match</c> condition evaluates to
/// <c>true</c>, and; <c>If-Unmodified-Since</c> condition evaluates to <c>false</c>;
/// then, S3 returns 200 OK and the data requested.
/// </para>
///
/// <para>
/// If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers
/// are present in the request as follows:<c> If-None-Match</c> condition evaluates
/// to <c>false</c>, and; <c>If-Modified-Since</c> condition evaluates to
/// <c>true</c>; then, S3 returns 304 Not Modified response code.
/// </para>
///
/// <para>
/// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC
/// 7232</a>.
/// </para>
///
/// <para>
/// The following operations are related to <c>GetObject</c>:
/// </para>
/// <ul> <li>
/// <para>
/// <a>ListBuckets</a>
/// </para>
/// </li> <li>
/// <para>
/// <a>GetObjectAcl</a>
/// </para>
/// </li> </ul>
/// </summary>
/// <remarks>
/// When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data.
/// This is to verify that the object has not been modified since it was encrypted.
/// </remarks>
/// <param name="bucketName">The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</param>
/// <param name="key">Key of the object to get.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The response from the GetObject service method, as returned by S3.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso>
public override System.Threading.Tasks.Task<GetObjectResponse> GetObjectAsync(string bucketName, string key,
System.Threading.CancellationToken cancellationToken = new System.Threading.CancellationToken())
{
return base.GetObjectAsync(bucketName, key, cancellationToken);
}
/// <summary>
/// Retrieves objects from Amazon S3. To use <c>GET</c>, you must have <c>READ</c>
/// access to the object. If you grant <c>READ</c> access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
/// <para>
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// <c>sample.jpg</c>, you can name it <c>photos/2006/February/sample.jpg</c>.
/// </para>
///
/// <para>
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the <c>GET</c> operation. For a virtual hosted-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c>, specify the resource
/// as <c>/photos/2006/February/sample.jpg</c>. For a path-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c> in the bucket
/// named <c>examplebucket</c>, specify the resource as <c>/examplebucket/photos/2006/February/sample.jpg</c>.
/// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP
/// Host Header Bucket Specification</a>.
/// </para>
///
/// <para>
/// To distribute large files to many people, you can save bandwidth costs by using BitTorrent.
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Amazon
/// S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.
/// </para>
///
/// <para>
/// If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage
/// classes, before you can retrieve the object you must first restore a copy using .
/// Otherwise, this operation returns an <c>InvalidObjectStateError</c> error. For
/// information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
/// Archived Objects</a>.
/// </para>
///
/// <para>
/// Encryption request headers, like <c>x-amz-server-side-encryption</c>, should
/// not be sent for GET requests if your object uses server-side encryption with CMKs
/// stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
/// keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
/// BadRequest error.
/// </para>
///
/// <para>
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
/// </para>
/// <ul> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-algorithm
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key-MD5
/// </para>
/// </li> </ul>
/// <para>
/// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
/// Encryption (Using Customer-Provided Encryption Keys)</a>.
/// </para>
///
/// <para>
/// Assuming you have permission to read object tags (permission for the <c>s3:GetObjectVersionTagging</c>
/// action), the response also returns the <c>x-amz-tagging-count</c> header that
/// provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a>
/// to retrieve the tag set associated with an object.
/// </para>
///
/// <para>
/// <b>Permissions</b>
/// </para>
///
/// <para>
/// You need the <c>s3:GetObject</c> permission for this operation. For more information,
/// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
/// Permissions in a Policy</a>. If the object you request does not exist, the error Amazon
/// S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission.
/// </para>
/// <ul> <li>
/// <para>
/// If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 will
/// return an HTTP status code 404 ("no such key") error.
/// </para>
/// </li> <li>
/// <para>
/// If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 will return
/// an HTTP status code 403 ("access denied") error.
/// </para>
/// </li> </ul>
/// <para>
/// <b>Versioning</b>
/// </para>
///
/// <para>
/// By default, the GET operation returns the current version of an object. To return
/// a different version, use the <c>versionId</c> subresource.
/// </para>
/// <note>
/// <para>
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes <c>x-amz-delete-marker: true</c> in the response.
/// </para>
/// </note>
/// <para>
/// For more information about versioning, see <a>PutBucketVersioning</a>.
/// </para>
///
/// <para>
/// <b>Overriding Response Header Values</b>
/// </para>
///
/// <para>
/// There are times when you want to override certain response header values in a GET
/// response. For example, you might override the Content-Disposition response header
/// value in your GET request.
/// </para>
///
/// <para>
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are <c>Content-Type</c>,
/// <c>Content-Language</c>, <c>Expires</c>, <c>Cache-Control</c>, <c>Content-Disposition</c>,
/// and <c>Content-Encoding</c>. To override these header values in the GET response,
/// you use the following request parameters.
/// </para>
/// <note>
/// <para>
/// You must sign the request, either using an Authorization header or a presigned URL,
/// when using these parameters. They cannot be used with an unsigned (anonymous) request.
/// </para>
/// </note> <ul> <li>
/// <para>
/// <c>response-content-type</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-language</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-expires</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-cache-control</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-disposition</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-encoding</c>
/// </para>
/// </li> </ul>
/// <para>
/// <b>Additional Considerations about Request Headers</b>
/// </para>
///
/// <para>
/// If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers
/// are present in the request as follows: <c>If-Match</c> condition evaluates to
/// <c>true</c>, and; <c>If-Unmodified-Since</c> condition evaluates to <c>false</c>;
/// then, S3 returns 200 OK and the data requested.
/// </para>
///
/// <para>
/// If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers
/// are present in the request as follows:<c> If-None-Match</c> condition evaluates
/// to <c>false</c>, and; <c>If-Modified-Since</c> condition evaluates to
/// <c>true</c>; then, S3 returns 304 Not Modified response code.
/// </para>
///
/// <para>
/// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC
/// 7232</a>.
/// </para>
///
/// <para>
/// The following operations are related to <c>GetObject</c>:
/// </para>
/// <ul> <li>
/// <para>
/// <a>ListBuckets</a>
/// </para>
/// </li> <li>
/// <para>
/// <a>GetObjectAcl</a>
/// </para>
/// </li> </ul>
/// </summary>
/// <remarks>
/// When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data.
/// This is to verify that the object has not been modified since it was encrypted.
/// </remarks>
/// <param name="bucketName">The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</param>
/// <param name="key">Key of the object to get.</param>
/// <param name="versionId">VersionId used to reference a specific version of the object.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The response from the GetObject service method, as returned by S3.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso>
public override System.Threading.Tasks.Task<GetObjectResponse> GetObjectAsync(string bucketName, string key, string versionId,
System.Threading.CancellationToken cancellationToken = new System.Threading.CancellationToken())
{
return base.GetObjectAsync(bucketName, key, versionId, cancellationToken);
}
#endif
#if BCL
/// <summary>
/// Retrieves objects from Amazon S3. To use <c>GET</c>, you must have <c>READ</c>
/// access to the object. If you grant <c>READ</c> access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
/// <para>
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// <c>sample.jpg</c>, you can name it <c>photos/2006/February/sample.jpg</c>.
/// </para>
///
/// <para>
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the <c>GET</c> operation. For a virtual hosted-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c>, specify the resource
/// as <c>/photos/2006/February/sample.jpg</c>. For a path-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c> in the bucket
/// named <c>examplebucket</c>, specify the resource as <c>/examplebucket/photos/2006/February/sample.jpg</c>.
/// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP
/// Host Header Bucket Specification</a>.
/// </para>
///
/// <para>
/// To distribute large files to many people, you can save bandwidth costs by using BitTorrent.
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Amazon
/// S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.
/// </para>
///
/// <para>
/// If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage
/// classes, before you can retrieve the object you must first restore a copy using .
/// Otherwise, this operation returns an <c>InvalidObjectStateError</c> error. For
/// information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
/// Archived Objects</a>.
/// </para>
///
/// <para>
/// Encryption request headers, like <c>x-amz-server-side-encryption</c>, should
/// not be sent for GET requests if your object uses server-side encryption with CMKs
/// stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
/// keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
/// BadRequest error.
/// </para>
///
/// <para>
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
/// </para>
/// <ul> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-algorithm
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key-MD5
/// </para>
/// </li> </ul>
/// <para>
/// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
/// Encryption (Using Customer-Provided Encryption Keys)</a>.
/// </para>
///
/// <para>
/// Assuming you have permission to read object tags (permission for the <c>s3:GetObjectVersionTagging</c>
/// action), the response also returns the <c>x-amz-tagging-count</c> header that
/// provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a>
/// to retrieve the tag set associated with an object.
/// </para>
///
/// <para>
/// <b>Permissions</b>
/// </para>
///
/// <para>
/// You need the <c>s3:GetObject</c> permission for this operation. For more information,
/// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
/// Permissions in a Policy</a>. If the object you request does not exist, the error Amazon
/// S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission.
/// </para>
/// <ul> <li>
/// <para>
/// If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 will
/// return an HTTP status code 404 ("no such key") error.
/// </para>
/// </li> <li>
/// <para>
/// If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 will return
/// an HTTP status code 403 ("access denied") error.
/// </para>
/// </li> </ul>
/// <para>
/// <b>Versioning</b>
/// </para>
///
/// <para>
/// By default, the GET operation returns the current version of an object. To return
/// a different version, use the <c>versionId</c> subresource.
/// </para>
/// <note>
/// <para>
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes <c>x-amz-delete-marker: true</c> in the response.
/// </para>
/// </note>
/// <para>
/// For more information about versioning, see <a>PutBucketVersioning</a>.
/// </para>
///
/// <para>
/// <b>Overriding Response Header Values</b>
/// </para>
///
/// <para>
/// There are times when you want to override certain response header values in a GET
/// response. For example, you might override the Content-Disposition response header
/// value in your GET request.
/// </para>
///
/// <para>
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are <c>Content-Type</c>,
/// <c>Content-Language</c>, <c>Expires</c>, <c>Cache-Control</c>, <c>Content-Disposition</c>,
/// and <c>Content-Encoding</c>. To override these header values in the GET response,
/// you use the following request parameters.
/// </para>
/// <note>
/// <para>
/// You must sign the request, either using an Authorization header or a presigned URL,
/// when using these parameters. They cannot be used with an unsigned (anonymous) request.
/// </para>
/// </note> <ul> <li>
/// <para>
/// <c>response-content-type</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-language</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-expires</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-cache-control</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-disposition</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-encoding</c>
/// </para>
/// </li> </ul>
/// <para>
/// <b>Additional Considerations about Request Headers</b>
/// </para>
///
/// <para>
/// If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers
/// are present in the request as follows: <c>If-Match</c> condition evaluates to
/// <c>true</c>, and; <c>If-Unmodified-Since</c> condition evaluates to <c>false</c>;
/// then, S3 returns 200 OK and the data requested.
/// </para>
///
/// <para>
/// If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers
/// are present in the request as follows:<c> If-None-Match</c> condition evaluates
/// to <c>false</c>, and; <c>If-Modified-Since</c> condition evaluates to
/// <c>true</c>; then, S3 returns 304 Not Modified response code.
/// </para>
///
/// <para>
/// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC
/// 7232</a>.
/// </para>
///
/// <para>
/// The following operations are related to <c>GetObject</c>:
/// </para>
/// <ul> <li>
/// <para>
/// <a>ListBuckets</a>
/// </para>
/// </li> <li>
/// <para>
/// <a>GetObjectAcl</a>
/// </para>
/// </li> </ul>
/// </summary>
/// <remarks>
/// When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data.
/// This is to verify that the object has not been modified since it was encrypted.
/// </remarks>
/// <param name="request">Container for the necessary parameters to execute the GetObject service method.</param>
/// <returns>The response from the GetObject service method, as returned by S3.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso>
public override GetObjectResponse GetObject(GetObjectRequest request)
{
return base.GetObject(request);
}
/// <summary>
/// Retrieves objects from Amazon S3. To use <c>GET</c>, you must have <c>READ</c>
/// access to the object. If you grant <c>READ</c> access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
/// <para>
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// <c>sample.jpg</c>, you can name it <c>photos/2006/February/sample.jpg</c>.
/// </para>
///
/// <para>
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the <c>GET</c> operation. For a virtual hosted-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c>, specify the resource
/// as <c>/photos/2006/February/sample.jpg</c>. For a path-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c> in the bucket
/// named <c>examplebucket</c>, specify the resource as <c>/examplebucket/photos/2006/February/sample.jpg</c>.
/// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP
/// Host Header Bucket Specification</a>.
/// </para>
///
/// <para>
/// To distribute large files to many people, you can save bandwidth costs by using BitTorrent.
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Amazon
/// S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.
/// </para>
///
/// <para>
/// If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage
/// classes, before you can retrieve the object you must first restore a copy using .
/// Otherwise, this operation returns an <c>InvalidObjectStateError</c> error. For
/// information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
/// Archived Objects</a>.
/// </para>
///
/// <para>
/// Encryption request headers, like <c>x-amz-server-side-encryption</c>, should
/// not be sent for GET requests if your object uses server-side encryption with CMKs
/// stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
/// keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
/// BadRequest error.
/// </para>
///
/// <para>
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
/// </para>
/// <ul> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-algorithm
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key-MD5
/// </para>
/// </li> </ul>
/// <para>
/// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
/// Encryption (Using Customer-Provided Encryption Keys)</a>.
/// </para>
///
/// <para>
/// Assuming you have permission to read object tags (permission for the <c>s3:GetObjectVersionTagging</c>
/// action), the response also returns the <c>x-amz-tagging-count</c> header that
/// provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a>
/// to retrieve the tag set associated with an object.
/// </para>
///
/// <para>
/// <b>Permissions</b>
/// </para>
///
/// <para>
/// You need the <c>s3:GetObject</c> permission for this operation. For more information,
/// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
/// Permissions in a Policy</a>. If the object you request does not exist, the error Amazon
/// S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission.
/// </para>
/// <ul> <li>
/// <para>
/// If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 will
/// return an HTTP status code 404 ("no such key") error.
/// </para>
/// </li> <li>
/// <para>
/// If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 will return
/// an HTTP status code 403 ("access denied") error.
/// </para>
/// </li> </ul>
/// <para>
/// <b>Versioning</b>
/// </para>
///
/// <para>
/// By default, the GET operation returns the current version of an object. To return
/// a different version, use the <c>versionId</c> subresource.
/// </para>
/// <note>
/// <para>
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes <c>x-amz-delete-marker: true</c> in the response.
/// </para>
/// </note>
/// <para>
/// For more information about versioning, see <a>PutBucketVersioning</a>.
/// </para>
///
/// <para>
/// <b>Overriding Response Header Values</b>
/// </para>
///
/// <para>
/// There are times when you want to override certain response header values in a GET
/// response. For example, you might override the Content-Disposition response header
/// value in your GET request.
/// </para>
///
/// <para>
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are <c>Content-Type</c>,
/// <c>Content-Language</c>, <c>Expires</c>, <c>Cache-Control</c>, <c>Content-Disposition</c>,
/// and <c>Content-Encoding</c>. To override these header values in the GET response,
/// you use the following request parameters.
/// </para>
/// <note>
/// <para>
/// You must sign the request, either using an Authorization header or a presigned URL,
/// when using these parameters. They cannot be used with an unsigned (anonymous) request.
/// </para>
/// </note> <ul> <li>
/// <para>
/// <c>response-content-type</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-language</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-expires</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-cache-control</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-disposition</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-encoding</c>
/// </para>
/// </li> </ul>
/// <para>
/// <b>Additional Considerations about Request Headers</b>
/// </para>
///
/// <para>
/// If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers
/// are present in the request as follows: <c>If-Match</c> condition evaluates to
/// <c>true</c>, and; <c>If-Unmodified-Since</c> condition evaluates to <c>false</c>;
/// then, S3 returns 200 OK and the data requested.
/// </para>
///
/// <para>
/// If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers
/// are present in the request as follows:<c> If-None-Match</c> condition evaluates
/// to <c>false</c>, and; <c>If-Modified-Since</c> condition evaluates to
/// <c>true</c>; then, S3 returns 304 Not Modified response code.
/// </para>
///
/// <para>
/// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC
/// 7232</a>.
/// </para>
///
/// <para>
/// The following operations are related to <c>GetObject</c>:
/// </para>
/// <ul> <li>
/// <para>
/// <a>ListBuckets</a>
/// </para>
/// </li> <li>
/// <para>
/// <a>GetObjectAcl</a>
/// </para>
/// </li> </ul>
/// </summary>
/// <remarks>
/// When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data.
/// This is to verify that the object has not been modified since it was encrypted.
/// </remarks>
/// <param name="bucketName">The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</param>
/// <param name="key">Key of the object to get.</param>
/// <returns>The response from the GetObject service method, as returned by S3.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso>
public override GetObjectResponse GetObject(string bucketName, string key)
{
return base.GetObject(bucketName, key);
}
/// <summary>
/// Retrieves objects from Amazon S3. To use <c>GET</c>, you must have <c>READ</c>
/// access to the object. If you grant <c>READ</c> access to the anonymous user,
/// you can return the object without using an authorization header.
///
///
/// <para>
/// An Amazon S3 bucket has no directory hierarchy such as you would find in a typical
/// computer file system. You can, however, create a logical hierarchy by using object
/// key names that imply a folder structure. For example, instead of naming an object
/// <c>sample.jpg</c>, you can name it <c>photos/2006/February/sample.jpg</c>.
/// </para>
///
/// <para>
/// To get an object from such a logical hierarchy, specify the full key name for the
/// object in the <c>GET</c> operation. For a virtual hosted-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c>, specify the resource
/// as <c>/photos/2006/February/sample.jpg</c>. For a path-style request example,
/// if you have the object <c>photos/2006/February/sample.jpg</c> in the bucket
/// named <c>examplebucket</c>, specify the resource as <c>/examplebucket/photos/2006/February/sample.jpg</c>.
/// For more information about request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP
/// Host Header Bucket Specification</a>.
/// </para>
///
/// <para>
/// To distribute large files to many people, you can save bandwidth costs by using BitTorrent.
/// For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html">Amazon
/// S3 Torrent</a>. For more information about returning the ACL of an object, see <a>GetObjectAcl</a>.
/// </para>
///
/// <para>
/// If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage
/// classes, before you can retrieve the object you must first restore a copy using .
/// Otherwise, this operation returns an <c>InvalidObjectStateError</c> error. For
/// information about restoring archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
/// Archived Objects</a>.
/// </para>
///
/// <para>
/// Encryption request headers, like <c>x-amz-server-side-encryption</c>, should
/// not be sent for GET requests if your object uses server-side encryption with CMKs
/// stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
/// keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
/// BadRequest error.
/// </para>
///
/// <para>
/// If you encrypt an object by using server-side encryption with customer-provided encryption
/// keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
/// you must use the following headers:
/// </para>
/// <ul> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-algorithm
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key
/// </para>
/// </li> <li>
/// <para>
/// x-amz-server-side​-encryption​-customer-key-MD5
/// </para>
/// </li> </ul>
/// <para>
/// For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
/// Encryption (Using Customer-Provided Encryption Keys)</a>.
/// </para>
///
/// <para>
/// Assuming you have permission to read object tags (permission for the <c>s3:GetObjectVersionTagging</c>
/// action), the response also returns the <c>x-amz-tagging-count</c> header that
/// provides the count of number of tags associated with the object. You can use <a>GetObjectTagging</a>
/// to retrieve the tag set associated with an object.
/// </para>
///
/// <para>
/// <b>Permissions</b>
/// </para>
///
/// <para>
/// You need the <c>s3:GetObject</c> permission for this operation. For more information,
/// see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
/// Permissions in a Policy</a>. If the object you request does not exist, the error Amazon
/// S3 returns depends on whether you also have the <c>s3:ListBucket</c> permission.
/// </para>
/// <ul> <li>
/// <para>
/// If you have the <c>s3:ListBucket</c> permission on the bucket, Amazon S3 will
/// return an HTTP status code 404 ("no such key") error.
/// </para>
/// </li> <li>
/// <para>
/// If you don’t have the <c>s3:ListBucket</c> permission, Amazon S3 will return
/// an HTTP status code 403 ("access denied") error.
/// </para>
/// </li> </ul>
/// <para>
/// <b>Versioning</b>
/// </para>
///
/// <para>
/// By default, the GET operation returns the current version of an object. To return
/// a different version, use the <c>versionId</c> subresource.
/// </para>
/// <note>
/// <para>
/// If the current version of the object is a delete marker, Amazon S3 behaves as if the
/// object was deleted and includes <c>x-amz-delete-marker: true</c> in the response.
/// </para>
/// </note>
/// <para>
/// For more information about versioning, see <a>PutBucketVersioning</a>.
/// </para>
///
/// <para>
/// <b>Overriding Response Header Values</b>
/// </para>
///
/// <para>
/// There are times when you want to override certain response header values in a GET
/// response. For example, you might override the Content-Disposition response header
/// value in your GET request.
/// </para>
///
/// <para>
/// You can override values for a set of response headers using the following query parameters.
/// These response header values are sent only on a successful request, that is, when
/// status code 200 OK is returned. The set of headers you can override using these parameters
/// is a subset of the headers that Amazon S3 accepts when you create an object. The response
/// headers that you can override for the GET response are <c>Content-Type</c>,
/// <c>Content-Language</c>, <c>Expires</c>, <c>Cache-Control</c>, <c>Content-Disposition</c>,
/// and <c>Content-Encoding</c>. To override these header values in the GET response,
/// you use the following request parameters.
/// </para>
/// <note>
/// <para>
/// You must sign the request, either using an Authorization header or a presigned URL,
/// when using these parameters. They cannot be used with an unsigned (anonymous) request.
/// </para>
/// </note> <ul> <li>
/// <para>
/// <c>response-content-type</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-language</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-expires</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-cache-control</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-disposition</c>
/// </para>
/// </li> <li>
/// <para>
/// <c>response-content-encoding</c>
/// </para>
/// </li> </ul>
/// <para>
/// <b>Additional Considerations about Request Headers</b>
/// </para>
///
/// <para>
/// If both of the <c>If-Match</c> and <c>If-Unmodified-Since</c> headers
/// are present in the request as follows: <c>If-Match</c> condition evaluates to
/// <c>true</c>, and; <c>If-Unmodified-Since</c> condition evaluates to <c>false</c>;
/// then, S3 returns 200 OK and the data requested.
/// </para>
///
/// <para>
/// If both of the <c>If-None-Match</c> and <c>If-Modified-Since</c> headers
/// are present in the request as follows:<c> If-None-Match</c> condition evaluates
/// to <c>false</c>, and; <c>If-Modified-Since</c> condition evaluates to
/// <c>true</c>; then, S3 returns 304 Not Modified response code.
/// </para>
///
/// <para>
/// For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC
/// 7232</a>.
/// </para>
///
/// <para>
/// The following operations are related to <c>GetObject</c>:
/// </para>
/// <ul> <li>
/// <para>
/// <a>ListBuckets</a>
/// </para>
/// </li> <li>
/// <para>
/// <a>GetObjectAcl</a>
/// </para>
/// </li> </ul>
/// </summary>
/// <remarks>
/// When decrypting with AES-GCM, read the entire object to the end before you start using the decrypted data.
/// This is to verify that the object has not been modified since it was encrypted.
/// </remarks>
/// <param name="bucketName">The bucket name containing the object. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</param>
/// <param name="key">Key of the object to get.</param>
/// <param name="versionId">VersionId used to reference a specific version of the object.</param>
/// <returns>The response from the GetObject service method, as returned by S3.</returns>
/// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject">REST API Reference for GetObject Operation</seealso>
public override GetObjectResponse GetObject(string bucketName, string key, string versionId)
{
return base.GetObject(bucketName, key, versionId);
}
#endif
}
}
| 1,369 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// Mode for string the encryption information for an object.
/// </summary>
public enum CryptoStorageMode
{
/// <summary>
/// Store the information in a separate S3 Object.
/// </summary>
InstructionFile,
/// <summary>
/// Store the information as metadata on the encrypted object.
/// </summary>
ObjectMetadata
}
} | 37 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// Encryption Instructions store the encryption credentials
/// </summary>
public class EncryptionInstructions
{
internal byte[] EnvelopeKey { get; private set; }
internal byte[] EncryptedEnvelopeKey { get; private set; }
internal byte[] InitializationVector { get; private set; }
internal Dictionary<string, string> MaterialsDescription { get; private set; }
/// <summary>
/// Algorithm used to encrypt/decrypt content
/// </summary>
internal string CekAlgorithm { get; }
/// <summary>
/// Algorithm used to encrypt/decrypt envelope key
/// </summary>
internal string WrapAlgorithm { get; }
/// <summary>
/// Construct an instance EncryptionInstructions.
/// </summary>
/// <param name="materialsDescription"></param>
/// <param name="envelopeKey"></param>
/// <param name="encryptedKey"></param>
/// <param name="iv"></param>
/// <param name="wrapAlgorithm"></param>
/// <param name="cekAlgorithm"></param>
public EncryptionInstructions(Dictionary<string, string> materialsDescription, byte[] envelopeKey, byte[] encryptedKey, byte[] iv, string wrapAlgorithm = null,
string cekAlgorithm = null)
{
MaterialsDescription = materialsDescription;
EnvelopeKey = envelopeKey;
EncryptedEnvelopeKey = encryptedKey;
InitializationVector = iv;
WrapAlgorithm = wrapAlgorithm;
CekAlgorithm = cekAlgorithm;
}
/// <summary>
/// Construct an instance EncryptionInstructions.
/// </summary>
/// <param name="materialsDescription"></param>
/// <param name="envelopeKey"></param>
/// <param name="iv"></param>
public EncryptionInstructions(Dictionary<string, string> materialsDescription, byte[] envelopeKey, byte[] iv) :
this(materialsDescription, envelopeKey, null, iv)
{
}
}
}
| 75 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// The "key encrypting key" materials used in encrypt/decryption.
/// These materials may be an asymmetric key, a symmetric key, or a KMS key ID.
/// </summary>
public class EncryptionMaterials : EncryptionMaterialsBase
{
/// <inheritdoc />
public EncryptionMaterials(AsymmetricAlgorithm algorithm) : base(algorithm)
{
}
/// <inheritdoc />
public EncryptionMaterials(SymmetricAlgorithm algorithm) : base(algorithm)
{
}
/// <inheritdoc />
public EncryptionMaterials(string kmsKeyID) : base(kmsKeyID)
{
MaterialsDescription.Add(EncryptionUtils.KMSCmkIDKey, kmsKeyID);
}
}
}
| 47 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// Base class for EncryptionMaterials materials
/// Encapsulates common properties and methods of the encryption materials
/// </summary>
public class EncryptionMaterialsBase
{
internal AsymmetricAlgorithm AsymmetricProvider { get; }
internal SymmetricAlgorithm SymmetricProvider { get; }
internal string KMSKeyID { get; }
internal Dictionary<string, string> MaterialsDescription { get; }
/// <summary>
/// Constructs a new EncryptionMaterials object, storing an asymmetric key.
/// </summary>
/// <param name="algorithm"></param>
public EncryptionMaterialsBase(AsymmetricAlgorithm algorithm) : this(algorithm, null, null, new Dictionary<string, string>())
{
}
/// <summary>
/// Constructs a new EncryptionMaterials object, storing a symmetric key.
/// </summary>
/// <param name="algorithm"></param>
public EncryptionMaterialsBase(SymmetricAlgorithm algorithm) : this(null, algorithm, null, new Dictionary<string, string>())
{
}
/// <summary>
/// Constructs a new EncryptionMaterials object, storing a KMS Key ID & material description used as encryption context to call KMS
/// </summary>
/// <param name="kmsKeyID">KmsContext customer master key</param>
public EncryptionMaterialsBase(string kmsKeyID) : this(null, null, kmsKeyID, new Dictionary<string, string>())
{
if (string.IsNullOrEmpty(kmsKeyID))
{
throw new ArgumentNullException(nameof(kmsKeyID));
}
}
internal EncryptionMaterialsBase(AsymmetricAlgorithm asymmetricAlgorithm, SymmetricAlgorithm symmetricAlgorithm, string kmsKeyID, Dictionary<string, string> materialsDescription)
{
AsymmetricProvider = asymmetricAlgorithm;
SymmetricProvider = symmetricAlgorithm;
KMSKeyID = kmsKeyID;
MaterialsDescription = materialsDescription;
}
}
}
| 75 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.Primitives;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// The "key encrypting key" materials used in encrypt/decryption.
/// These materials may be an asymmetric key, a symmetric key, or a KMS key ID.
/// Every material has its unique type such as RsaOaepSha1, AesGcm or KmsContext respectively.
/// </summary>
public class EncryptionMaterialsV2 : EncryptionMaterialsBase
{
/// <summary>
/// Type of of the asymmetric algorithm
/// </summary>
internal SymmetricAlgorithmType SymmetricProviderType { get; }
/// <summary>
/// Type of of the asymmetric algorithm
/// </summary>
internal AsymmetricAlgorithmType AsymmetricProviderType { get; }
/// <summary>
/// Type of the KMS Id
/// </summary>
internal KmsType KmsType { get; }
/// <summary>
/// Constructs a new EncryptionMaterials object, storing an asymmetric key.
/// </summary>
/// <param name="algorithm">Generic asymmetric algorithm</param>
/// <param name="algorithmType">Type of of the asymmetric algorithm</param>
public EncryptionMaterialsV2(AsymmetricAlgorithm algorithm, AsymmetricAlgorithmType algorithmType) : base(algorithm)
{
AsymmetricProviderType = algorithmType;
}
/// <summary>
/// Constructs a new EncryptionMaterials object, storing a symmetric key.
/// </summary>
/// <param name="algorithm">Generic symmetric algorithm</param>
/// <param name="algorithmType">Type of the symmetric algorithm</param>
public EncryptionMaterialsV2(SymmetricAlgorithm algorithm, SymmetricAlgorithmType algorithmType) : base(algorithm)
{
SymmetricProviderType = algorithmType;
}
/// <summary>
/// Constructs a new EncryptionMaterials object, storing a KMS Key ID
/// </summary>
/// <param name="kmsKeyId">Generic KMS Id</param>
/// <param name="kmsType">Type of the KMS Id</param>
/// <param name="materialsDescription"></param>
public EncryptionMaterialsV2(string kmsKeyId, KmsType kmsType, Dictionary<string, string> materialsDescription)
: base(null, null, kmsKeyId, materialsDescription)
{
if (materialsDescription == null)
{
throw new ArgumentNullException(nameof(materialsDescription));
}
if (materialsDescription.ContainsKey(EncryptionUtils.XAmzEncryptionContextCekAlg))
{
throw new ArgumentException($"Conflict in reserved KMS Encryption Context key {EncryptionUtils.XAmzEncryptionContextCekAlg}. " +
$"This value is reserved for the S3 Encryption Client and cannot be set by the user.");
}
materialsDescription[EncryptionUtils.XAmzEncryptionContextCekAlg] = EncryptionUtils.XAmzAesGcmCekAlgValue;
KmsType = kmsType;
}
}
}
| 92 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
using System.Security.Cryptography;
using Amazon.S3.Model;
using Amazon.Runtime.Internal.Util;
using Amazon.Runtime;
using ThirdParty.Json.LitJson;
using System.Collections.Generic;
using System.Globalization;
using Amazon.KeyManagementService;
using Amazon.Runtime.SharedInterfaces;
using Amazon.Extensions.S3.Encryption.Util;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// The EncryptionUtils class encrypts and decrypts data stored in S3.
/// It can be used to prepare requests for encryption before they are stored in S3
/// and to decrypt objects that are retrieved from S3.
/// </summary>
internal static partial class EncryptionUtils
{
// v1-specific constants
private const string XAmzKey = "x-amz-key";
// v2-specific constants
public const string KMSCmkIDKey = "kms_cmk_id";
public const string KMSKeySpec = "AES_256";
public const string XAmzKeyV2 = "x-amz-key-v2";
internal const string XAmzWrapAlg = "x-amz-wrap-alg";
internal const string XAmzCekAlg = "x-amz-cek-alg";
internal const string XAmzEncryptionContextCekAlg = "aws:x-amz-cek-alg";
internal const string XAmzTagLen = "x-amz-tag-len";
// Old instruction file related constants
internal const string EncryptionInstructionFileSuffix = "INSTRUCTION_SUFFIX";
internal const string EncryptedEnvelopeKey = "EncryptedEnvelopeKey";
internal const string IV = "IV";
// shared constants
public const string XAmzMatDesc = "x-amz-matdesc";
private const string XAmzIV = "x-amz-iv";
private const string XAmzUnencryptedContentLength = "x-amz-unencrypted-content-length";
private const string XAmzCryptoInstrFile = "x-amz-crypto-instr-file";
private const int IVLength = 16;
internal const int DefaultTagBitsLength = 128; // In bits
internal const int DefaultNonceSize = 12;
internal const string EncryptionInstructionFileV2Suffix = ".instruction";
internal const string NoSuchKey = "NoSuchKey";
internal const string SDKEncryptionDocsUrl = "https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html";
// v2-specific values
// These values are hard coded here because the
// .NET client only supports a subset of the features of the Java client.
internal const string XAmzWrapAlgKmsValue = "kms";
internal const string XAmzWrapAlgKmsContextValue = "kms+context";
internal const string XAmzWrapAlgRsaOaepSha1 = "RSA-OAEP-SHA1";
internal const string XAmzWrapAlgAesGcmValue = "AES/GCM";
internal const string XAmzAesCbcPaddingCekAlgValue = "AES/CBC/PKCS5Padding";
internal const string XAmzAesGcmCekAlgValue = "AES/GCM/NoPadding";
private const string ModeMessage = "Although this mode is supported by other AWS SDKs, the .NET SDK does not support it at this time.";
internal const string KmsKeyIdNullMessage = "Error generating encryption instructions. EncryptionMaterials must have the KMSKeyID set.";
internal static readonly HashSet<string> SupportedWrapAlgorithms = new HashSet<string>
{
XAmzWrapAlgKmsValue, XAmzWrapAlgKmsContextValue, XAmzWrapAlgRsaOaepSha1, XAmzWrapAlgAesGcmValue
};
internal static readonly HashSet<string> SupportedCekAlgorithms = new HashSet<string>
{
XAmzAesCbcPaddingCekAlgValue, XAmzAesGcmCekAlgValue
};
private static byte[] EncryptEnvelopeKeyUsingAsymmetricKeyPair(AsymmetricAlgorithm asymmetricAlgorithm, byte[] envelopeKey)
{
#if NETSTANDARD
RSA rsaCrypto = asymmetricAlgorithm as RSA;
if (rsaCrypto == null)
{
throw new NotSupportedException("RSA is the only supported algorithm with AsymmetricProvider.");
}
return rsaCrypto.Encrypt(envelopeKey, RSAEncryptionPadding.Pkcs1);
#else
RSACryptoServiceProvider rsaCrypto = asymmetricAlgorithm as RSACryptoServiceProvider;
return rsaCrypto.Encrypt(envelopeKey, false);
#endif
}
private static byte[] EncryptEnvelopeKeyUsingSymmetricKey(SymmetricAlgorithm symmetricAlgorithm, byte[] envelopeKey)
{
symmetricAlgorithm.Mode = CipherMode.ECB;
using (ICryptoTransform encryptor = symmetricAlgorithm.CreateEncryptor())
{
return (encryptor.TransformFinalBlock(envelopeKey, 0, envelopeKey.Length));
}
}
/// <summary>
/// Decrypts an encrypted Envelope key using the provided encryption materials
/// and returns it in raw byte array form.
/// </summary>
/// <param name="encryptedEnvelopeKey">Encrypted envelope key</param>
/// <param name="materials">Encryption materials needed to decrypt the encrypted envelope key</param>
/// <returns></returns>
internal static byte[] DecryptNonKMSEnvelopeKey(byte[] encryptedEnvelopeKey, EncryptionMaterialsBase materials)
{
if (materials.AsymmetricProvider != null)
{
return DecryptEnvelopeKeyUsingAsymmetricKeyPair(materials.AsymmetricProvider, encryptedEnvelopeKey);
}
if (materials.SymmetricProvider != null)
{
return DecryptEnvelopeKeyUsingSymmetricKey(materials.SymmetricProvider, encryptedEnvelopeKey);
}
throw new ArgumentException("Error decrypting non-KMS envelope key. " +
"EncryptionMaterials must have the AsymmetricProvider or SymmetricProvider set.");
}
private static byte[] DecryptEnvelopeKeyUsingAsymmetricKeyPair(AsymmetricAlgorithm asymmetricAlgorithm, byte[] encryptedEnvelopeKey)
{
#if NETSTANDARD
RSA rsaCrypto = asymmetricAlgorithm as RSA;
if (rsaCrypto == null)
{
throw new NotSupportedException("RSA is the only supported algorithm with AsymmetricProvider.");
}
return rsaCrypto.Decrypt(encryptedEnvelopeKey, RSAEncryptionPadding.Pkcs1);
#else
RSACryptoServiceProvider rsaCrypto = asymmetricAlgorithm as RSACryptoServiceProvider;
return rsaCrypto.Decrypt(encryptedEnvelopeKey, false);
#endif
}
private static byte[] DecryptEnvelopeKeyUsingSymmetricKey(SymmetricAlgorithm symmetricAlgorithm, byte[] encryptedEnvelopeKey)
{
symmetricAlgorithm.Mode = CipherMode.ECB;
using (ICryptoTransform decryptor = symmetricAlgorithm.CreateDecryptor())
{
return (decryptor.TransformFinalBlock(encryptedEnvelopeKey, 0, encryptedEnvelopeKey.Length));
}
}
#region StreamEncryption
/// <summary>
/// Returns an updated stream where the stream contains the encrypted object contents.
/// The specified instruction will be used to encrypt data.
/// </summary>
/// <param name="toBeEncrypted">
/// The stream whose contents are to be encrypted.
/// </param>
/// <param name="instructions">
/// The instruction that will be used to encrypt the object data.
/// </param>
/// <returns>
/// Encrypted stream, i.e input stream wrapped into encrypted stream
/// </returns>
internal static Stream EncryptRequestUsingInstruction(Stream toBeEncrypted, EncryptionInstructions instructions)
{
//wrap input stream into AESEncryptionPutObjectStream wrapper
AESEncryptionPutObjectStream aesEStream;
aesEStream = new AESEncryptionPutObjectStream(toBeEncrypted, instructions.EnvelopeKey, instructions.InitializationVector);
return aesEStream;
}
/// <summary>
/// Returns an updated input stream where the input stream contains the encrypted object contents.
/// The specified instruction will be used to encrypt data.
/// </summary>
/// <param name="toBeEncrypted">
/// The stream whose contents are to be encrypted.
/// </param>
/// <param name="instructions">
/// The instruction that will be used to encrypt the object data.
/// </param>
/// <returns>
/// Encrypted stream, i.e input stream wrapped into encrypted stream
/// </returns>
internal static Stream EncryptUploadPartRequestUsingInstructions(Stream toBeEncrypted, EncryptionInstructions instructions)
{
//wrap input stream into AESEncryptionStreamForUploadPart wrapper
AESEncryptionUploadPartStream aesEStream;
aesEStream = new AESEncryptionUploadPartStream(toBeEncrypted, instructions.EnvelopeKey, instructions.InitializationVector);
return aesEStream;
}
#endregion
#region StreamDecryption
/// <summary>
/// Updates object where the object
/// input stream contains the decrypted contents.
/// </summary>
/// <param name="response">
/// The getObject response whose contents are to be decrypted.
/// </param>
/// <param name="instructions">
/// The instruction that will be used to encrypt the object data.
/// </param>
internal static void DecryptObjectUsingInstructions(GetObjectResponse response, EncryptionInstructions instructions)
{
response.ResponseStream = DecryptStream(response.ResponseStream, instructions);
}
//wrap encrypted stream into AESDecriptionStream wrapper
internal static Stream DecryptStream(Stream encryptedStream, EncryptionInstructions encryptionInstructions)
{
AESDecryptionStream aesDecryptStream;
aesDecryptStream = new AESDecryptionStream(encryptedStream, encryptionInstructions.EnvelopeKey, encryptionInstructions.InitializationVector);
return aesDecryptStream;
}
/// <summary>
/// Updates object where the object
/// input stream contains the decrypted contents.
/// </summary>
/// <param name="response">
/// The getObject response whose contents are to be decrypted.
/// </param>
/// <param name="instructions">
/// The instruction that will be used to encrypt the object data.
/// </param>
internal static void DecryptObjectUsingInstructionsGcm(GetObjectResponse response, EncryptionInstructions instructions)
{
response.ResponseStream = new AesGcmDecryptStream(response.ResponseStream, instructions.EnvelopeKey, instructions.InitializationVector, DefaultTagBitsLength);
}
#endregion
#region InstructionGeneration
/// <summary>
/// Generates an instruction that will be used to encrypt an object
/// using materials with the KMSKeyID set.
/// </summary>
/// <param name="kmsClient">
/// Used to call KMS to generate a data key.
/// </param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt data.
/// </param>
/// <returns>
/// The instruction that will be used to encrypt an object.
/// </returns>
internal static EncryptionInstructions GenerateInstructionsForKMSMaterials(IAmazonKeyManagementService kmsClient, EncryptionMaterials materials)
{
if (materials.KMSKeyID == null)
{
throw new ArgumentNullException(nameof(materials.KMSKeyID), KmsKeyIdNullMessage);
}
var iv = new byte[IVLength];
// Generate IV, and get both the key and the encrypted key from KMS.
RandomNumberGenerator.Create().GetBytes(iv);
var generateDataKeyResult = kmsClient.GenerateDataKey(materials.KMSKeyID, materials.MaterialsDescription, KMSKeySpec);
return new EncryptionInstructions(materials.MaterialsDescription, generateDataKeyResult.KeyPlaintext, generateDataKeyResult.KeyCiphertext, iv,
XAmzWrapAlgKmsValue, XAmzAesCbcPaddingCekAlgValue);
}
#if AWS_ASYNC_API
/// <summary>
/// Generates an instruction that will be used to encrypt an object
/// using materials with the KMSKeyID set.
/// </summary>
/// <param name="kmsClient">
/// Used to call KMS to generate a data key.
/// </param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt data.
/// </param>
/// <returns>
/// The instruction that will be used to encrypt an object.
/// </returns>
internal static async System.Threading.Tasks.Task<EncryptionInstructions> GenerateInstructionsForKMSMaterialsAsync(
IAmazonKeyManagementService kmsClient, EncryptionMaterials materials)
{
if (materials.KMSKeyID == null)
{
throw new ArgumentNullException(nameof(materials.KMSKeyID), KmsKeyIdNullMessage);
}
var iv = new byte[IVLength];
// Generate IV, and get both the key and the encrypted key from KMS.
RandomNumberGenerator.Create().GetBytes(iv);
var generateDataKeyResult = await kmsClient.GenerateDataKeyAsync(materials.KMSKeyID, materials.MaterialsDescription, KMSKeySpec).ConfigureAwait(false);
return new EncryptionInstructions(materials.MaterialsDescription, generateDataKeyResult.KeyPlaintext, generateDataKeyResult.KeyCiphertext, iv,
XAmzWrapAlgKmsValue, XAmzAesCbcPaddingCekAlgValue);
}
#endif
/// <summary>
/// Generates an instruction that will be used to encrypt an object
/// using materials with the AsymmetricProvider or SymmetricProvider set.
/// </summary>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt data.
/// </param>
/// <returns>
/// The instruction that will be used to encrypt an object.
/// </returns>
internal static EncryptionInstructions GenerateInstructionsForNonKMSMaterials(EncryptionMaterials materials)
{
byte[] encryptedEnvelopeKey = null;
// Generate the IV and key, and encrypt the key locally.
Aes aesObject = Aes.Create();
if (materials.AsymmetricProvider != null)
encryptedEnvelopeKey = EncryptEnvelopeKeyUsingAsymmetricKeyPair(materials.AsymmetricProvider, aesObject.Key);
else if (materials.SymmetricProvider != null)
encryptedEnvelopeKey = EncryptEnvelopeKeyUsingSymmetricKey(materials.SymmetricProvider, aesObject.Key);
else
throw new ArgumentException("Error generating encryption instructions. " +
"EncryptionMaterials must have the AsymmetricProvider or SymmetricProvider set.");
return new EncryptionInstructions(materials.MaterialsDescription, aesObject.Key, encryptedEnvelopeKey, aesObject.IV, XAmzAesCbcPaddingCekAlgValue);
}
internal static GetObjectRequest GetInstructionFileRequest(GetObjectResponse response, string suffix)
{
GetObjectRequest request = new GetObjectRequest
{
BucketName = response.BucketName,
Key = response.Key + suffix
};
return request;
}
internal static void EnsureSupportedAlgorithms(MetadataCollection metadata)
{
if (metadata[XAmzKeyV2] != null)
{
var xAmzWrapAlgMetadataValue = metadata[XAmzWrapAlg];
if (!SupportedWrapAlgorithms.Contains(xAmzWrapAlgMetadataValue))
{
throw new InvalidDataException($"Value '{xAmzWrapAlgMetadataValue}' for metadata key '{XAmzWrapAlg}' is invalid." +
$"{typeof(AmazonS3EncryptionClient).Name} only supports '{XAmzWrapAlgKmsValue}' as the key wrap algorithm. {ModeMessage}");
}
var xAmzCekAlgMetadataValue = metadata[XAmzCekAlg];
if (!(SupportedCekAlgorithms.Contains(xAmzCekAlgMetadataValue)))
throw new InvalidDataException(string.Format(CultureInfo.InvariantCulture,
"Value '{0}' for metadata key '{1}' is invalid. {2} only supports '{3}' as the content encryption algorithm. {4}",
xAmzCekAlgMetadataValue, XAmzCekAlg, typeof(AmazonS3EncryptionClient).Name, XAmzAesCbcPaddingCekAlgValue, ModeMessage));
}
}
/// <summary>
/// Builds an instruction object from the object metadata.
/// </summary>
/// <param name="response">
/// A non-null object response that contains encryption information in its metadata.
/// </param>
/// <param name="materials">
/// The non-null encryption materials to be used to encrypt and decrypt Envelope key.
/// </param>
/// <param name="decryptedEnvelopeKeyKMS">
/// The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used.
/// </param>
/// <returns>
/// </returns>
internal static EncryptionInstructions BuildInstructionsFromObjectMetadata(
GetObjectResponse response, EncryptionMaterialsBase materials, byte[] decryptedEnvelopeKeyKMS)
{
MetadataCollection metadata = response.Metadata;
var materialDescription = GetMaterialDescriptionFromMetaData(response.Metadata);
if (metadata[XAmzKeyV2] != null)
{
EnsureSupportedAlgorithms(metadata);
var base64EncodedEncryptedEnvelopeKey = metadata[XAmzKeyV2];
var encryptedEnvelopeKey = Convert.FromBase64String(base64EncodedEncryptedEnvelopeKey);
var base64EncodedIV = metadata[XAmzIV];
var IV = Convert.FromBase64String(base64EncodedIV);
var cekAlgorithm = metadata[XAmzCekAlg];
var wrapAlgorithm = metadata[XAmzWrapAlg];
EncryptionInstructions instructions;
if (decryptedEnvelopeKeyKMS != null)
{
return new EncryptionInstructions(materialDescription, decryptedEnvelopeKeyKMS, encryptedEnvelopeKey, IV, wrapAlgorithm, cekAlgorithm);
}
else
{
byte[] decryptedEnvelopeKey;
if (XAmzWrapAlgRsaOaepSha1.Equals(wrapAlgorithm) || XAmzWrapAlgAesGcmValue.Equals(wrapAlgorithm))
{
decryptedEnvelopeKey = DecryptNonKmsEnvelopeKeyV2(encryptedEnvelopeKey, materials);
}
else
{
decryptedEnvelopeKey = DecryptNonKMSEnvelopeKey(encryptedEnvelopeKey, materials);
}
return new EncryptionInstructions(materialDescription, decryptedEnvelopeKey, encryptedEnvelopeKey, IV, wrapAlgorithm, cekAlgorithm);
}
}
else
{
string base64EncodedEncryptedEnvelopeKey = metadata[XAmzKey];
byte[] encryptedEnvelopeKey = Convert.FromBase64String(base64EncodedEncryptedEnvelopeKey);
byte[] decryptedEnvelopeKey = DecryptNonKMSEnvelopeKey(encryptedEnvelopeKey, materials);
string base64EncodedIV = metadata[XAmzIV];
byte[] IV = Convert.FromBase64String(base64EncodedIV);
return new EncryptionInstructions(materialDescription, decryptedEnvelopeKey, encryptedEnvelopeKey, IV);
}
}
/// <summary>
/// Builds an instruction object from the instruction file.
/// </summary>
/// <param name="response"> Instruction file GetObject response</param>
/// <param name="materials">
/// The non-null encryption materials to be used to encrypt and decrypt Envelope key.
/// </param>
/// <param name="decryptNonKmsEnvelopeKey">Func to be used to decrypt non KMS envelope key</param>
/// <returns>
/// A non-null instruction object containing encryption information.
/// </returns>
internal static EncryptionInstructions BuildInstructionsUsingInstructionFile(GetObjectResponse response, EncryptionMaterials materials,
Func<byte[], EncryptionMaterials, byte[]> decryptNonKmsEnvelopeKey)
{
using (TextReader textReader = new StreamReader(response.ResponseStream))
{
JsonData jsonData = JsonMapper.ToObject(textReader);
var base64EncodedEncryptedEnvelopeKey = jsonData["EncryptedEnvelopeKey"];
byte[] encryptedEnvelopeKey = Convert.FromBase64String((string)base64EncodedEncryptedEnvelopeKey);
byte[] decryptedEnvelopeKey = decryptNonKmsEnvelopeKey(encryptedEnvelopeKey, materials);
var base64EncodedIV = jsonData["IV"];
byte[] IV = Convert.FromBase64String((string)base64EncodedIV);
return new EncryptionInstructions(materials.MaterialsDescription, decryptedEnvelopeKey, IV);
}
}
/// <summary>
/// Build encryption instructions for UploadPartEncryptionContext
/// </summary>
/// <param name="context">UploadPartEncryptionContext which contains instructions used for encrypting multipart object</param>
/// <param name="encryptionMaterials">EncryptionMaterials which contains material used for encrypting multipart object</param>
/// <returns></returns>
internal static EncryptionInstructions BuildEncryptionInstructionsForInstructionFile(UploadPartEncryptionContext context, EncryptionMaterials encryptionMaterials)
{
var instructions = new EncryptionInstructions(encryptionMaterials.MaterialsDescription, context.EnvelopeKey, context.EncryptedEnvelopeKey, context.FirstIV);
return instructions;
}
#endregion
#region UpdateMetadata
/// <summary>
/// Update the request's ObjectMetadata with the necessary information for decrypting the object.
/// </summary>
/// <param name="request">
/// AmazonWebServiceRequest encrypted using the given instruction
/// </param>
/// <param name="instructions">
/// Non-null instruction used to encrypt the data in this AmazonWebServiceRequest.
/// </param>
/// <param name="useV2Metadata">
/// If true use V2 metadata format, otherwise use V1.
/// </param>
internal static void UpdateMetadataWithEncryptionInstructions(AmazonWebServiceRequest request, EncryptionInstructions instructions, bool useV2Metadata)
{
byte[] keyBytesToStoreInMetadata = instructions.EncryptedEnvelopeKey;
string base64EncodedEnvelopeKey = Convert.ToBase64String(keyBytesToStoreInMetadata);
byte[] IVToStoreInMetadata = instructions.InitializationVector;
string base64EncodedIV = Convert.ToBase64String(IVToStoreInMetadata);
MetadataCollection metadata = null;
var putObjectRequest = request as PutObjectRequest;
if (putObjectRequest != null)
metadata = putObjectRequest.Metadata;
var initiateMultipartrequest = request as InitiateMultipartUploadRequest;
if (initiateMultipartrequest != null)
metadata = initiateMultipartrequest.Metadata;
if (metadata != null)
{
if (useV2Metadata)
{
metadata.Add(XAmzKeyV2, base64EncodedEnvelopeKey);
metadata.Add(XAmzWrapAlg, instructions.WrapAlgorithm);
metadata.Add(XAmzCekAlg, instructions.CekAlgorithm);
}
else
{
metadata.Add(XAmzKey, base64EncodedEnvelopeKey);
}
metadata.Add(XAmzIV, base64EncodedIV);
metadata.Add(XAmzMatDesc, JsonMapper.ToJson(instructions.MaterialsDescription));
}
}
internal static PutObjectRequest CreateInstructionFileRequest(AmazonWebServiceRequest request, EncryptionInstructions instructions)
{
byte[] keyBytesToStoreInInstructionFile = instructions.EncryptedEnvelopeKey;
string base64EncodedEnvelopeKey = Convert.ToBase64String(keyBytesToStoreInInstructionFile);
byte[] IVToStoreInInstructionFile = instructions.InitializationVector;
string base64EncodedIV = Convert.ToBase64String(IVToStoreInInstructionFile);
JsonData jsonData = new JsonData();
jsonData["EncryptedEnvelopeKey"] = base64EncodedEnvelopeKey;
jsonData["IV"] = base64EncodedIV;
var contentBody = jsonData.ToJson();
var putObjectRequest = request as PutObjectRequest;
if (putObjectRequest != null)
{
return GetInstructionFileRequest(putObjectRequest.BucketName, putObjectRequest.Key, EncryptionInstructionFileSuffix, contentBody);
}
var completeMultiPartRequest = request as CompleteMultipartUploadRequest;
if (completeMultiPartRequest != null)
{
return GetInstructionFileRequest(completeMultiPartRequest.BucketName, completeMultiPartRequest.Key, EncryptionInstructionFileSuffix, contentBody);
}
return null;
}
/// <summary>
/// Adds UnEncrypted content length to object metadata
/// </summary>
/// <param name="request"></param>
internal static void AddUnencryptedContentLengthToMetadata(PutObjectRequest request)
{
long originalLength = request.InputStream.Length;
request.Metadata.Add(XAmzUnencryptedContentLength, originalLength.ToString(CultureInfo.InvariantCulture));
}
/// <summary>
/// checks if encryption credentials are in object metadata
/// </summary>
/// <param name="response">Response of the object</param>
/// <returns></returns>
internal static bool IsEncryptionInfoInMetadata(GetObjectResponse response)
{
MetadataCollection metadata = response.Metadata;
return ((metadata[XAmzKey] != null || metadata[XAmzKeyV2] != null) && metadata[XAmzIV] != null);
}
#endregion
}
}
| 580 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.Extensions.S3.Encryption.Util;
using Amazon.KeyManagementService;
using Amazon.Runtime;
using Amazon.S3.Model;
using ThirdParty.Json.LitJson;
namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// The EncryptionUtils class encrypts and decrypts data stored in S3.
/// It can be used to prepare requests for encryption before they are stored in S3
/// and to decrypt objects that are retrieved from S3.
/// </summary>
internal static partial class EncryptionUtils
{
/// <summary>
/// Decrypt the envelope key with RSA-OAEP-SHA1
/// </summary>
/// <param name="encryptedEnvelopeKey">Encrypted envelope key</param>
/// <param name="materials">Encryption materials needed to decrypt the encrypted envelope key</param>
/// <returns></returns>
internal static byte[] DecryptNonKmsEnvelopeKeyV2(byte[] encryptedEnvelopeKey, EncryptionMaterialsBase materials)
{
if (materials.AsymmetricProvider != null)
{
return DecryptEnvelopeKeyUsingAsymmetricKeyPairV2(materials.AsymmetricProvider, encryptedEnvelopeKey);
}
if (materials.SymmetricProvider != null)
{
return DecryptEnvelopeKeyUsingSymmetricKeyV2(materials.SymmetricProvider, encryptedEnvelopeKey);
}
throw new ArgumentException("Error decrypting non-KMS envelope key. " +
"EncryptionMaterials must have the AsymmetricProvider or SymmetricProvider set.");
}
private static byte[] DecryptEnvelopeKeyUsingAsymmetricKeyPairV2(AsymmetricAlgorithm asymmetricAlgorithm, byte[] encryptedEnvelopeKey)
{
var rsa = asymmetricAlgorithm as RSA;
if (rsa == null)
{
throw new NotSupportedException("RSA-OAEP-SHA1 is the only supported algorithm with AsymmetricProvider.");
}
var cipher = RsaUtils.CreateRsaOaepSha1Cipher(false, rsa);
var decryptedEnvelopeKey = cipher.DoFinal(encryptedEnvelopeKey);
return DecryptedDataKeyFromDecryptedEnvelopeKey(decryptedEnvelopeKey);
}
private static byte[] DecryptEnvelopeKeyUsingSymmetricKeyV2(SymmetricAlgorithm symmetricAlgorithm, byte[] encryptedEnvelopeKey)
{
var nonce = encryptedEnvelopeKey.Take(DefaultNonceSize).ToArray();
var encryptedKey = encryptedEnvelopeKey.Skip(nonce.Length).ToArray();
var associatedText = Encoding.UTF8.GetBytes(XAmzAesGcmCekAlgValue);
var cipher = AesGcmUtils.CreateCipher(false, symmetricAlgorithm.Key, DefaultTagBitsLength, nonce, associatedText);
var envelopeKey = cipher.DoFinal(encryptedKey);
return envelopeKey;
}
/// <summary>
/// Extract and return data key from the decrypted envelope key
/// Format: (1 byte is length of the key) + (envelope key) + (UTF-8 encoding of CEK algorithm)
/// </summary>
/// <param name="decryptedEnvelopeKey">DecryptedEnvelopeKey that contains the data key</param>
/// <returns></returns>
/// <exception cref="InvalidDataException">Throws when the CEK algorithm isn't supported for given envelope key</exception>
private static byte[] DecryptedDataKeyFromDecryptedEnvelopeKey(byte[] decryptedEnvelopeKey)
{
var keyLength = (int) decryptedEnvelopeKey[0];
var dataKey = decryptedEnvelopeKey.Skip(1).Take(keyLength);
var cekAlgorithm = Encoding.UTF8.GetString(decryptedEnvelopeKey.Skip(keyLength + 1).ToArray());
if (!XAmzAesGcmCekAlgValue.Equals(cekAlgorithm))
{
throw new InvalidDataException($"Value '{cekAlgorithm}' for CEK algorithm is invalid." +
$"{nameof(AmazonS3EncryptionClientV2)} only supports '{XAmzAesGcmCekAlgValue}' as the key CEK algorithm.");
}
return dataKey.ToArray();
}
/// <summary>
/// Returns an updated stream where the stream contains the encrypted object contents.
/// The specified instruction will be used to encrypt data.
/// </summary>
/// <param name="toBeEncrypted">
/// The stream whose contents are to be encrypted.
/// </param>
/// <param name="instructions">
/// The instruction that will be used to encrypt the object data.
/// </param>
/// <param name="shouldUseCachingStream">
/// Flag indicating if the caching stream should be used or not.
/// </param>
/// <returns>
/// Encrypted stream, i.e input stream wrapped into encrypted stream
/// </returns>
internal static Stream EncryptRequestUsingInstructionV2(Stream toBeEncrypted, EncryptionInstructions instructions, bool shouldUseCachingStream)
{
Stream gcmEncryptStream = (shouldUseCachingStream ?
new AesGcmEncryptCachingStream(toBeEncrypted, instructions.EnvelopeKey, instructions.InitializationVector, DefaultTagBitsLength)
: new AesGcmEncryptStream(toBeEncrypted, instructions.EnvelopeKey, instructions.InitializationVector, DefaultTagBitsLength)
);
return gcmEncryptStream;
}
/// <summary>
/// Generates an instruction that will be used to encrypt an object
/// using materials with the AsymmetricProvider or SymmetricProvider set.
/// </summary>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt data.
/// </param>
/// <returns>
/// The instruction that will be used to encrypt an object.
/// </returns>
internal static EncryptionInstructions GenerateInstructionsForNonKmsMaterialsV2(EncryptionMaterialsV2 materials)
{
// Generate the IV and key, and encrypt the key locally.
if (materials.AsymmetricProvider != null)
{
return EncryptEnvelopeKeyUsingAsymmetricKeyPairV2(materials);
}
if (materials.SymmetricProvider != null)
{
return EncryptEnvelopeKeyUsingSymmetricKeyV2(materials);
}
throw new ArgumentException("Error generating encryption instructions. " +
"EncryptionMaterials must have the AsymmetricProvider or SymmetricProvider set.");
}
private static EncryptionInstructions EncryptEnvelopeKeyUsingAsymmetricKeyPairV2(EncryptionMaterialsV2 materials)
{
var rsa = materials.AsymmetricProvider as RSA;
if (rsa == null)
{
throw new NotSupportedException("RSA is the only supported algorithm with this method.");
}
switch (materials.AsymmetricProviderType)
{
case AsymmetricAlgorithmType.RsaOaepSha1:
{
var aesObject = Aes.Create();
var nonce = aesObject.IV.Take(DefaultNonceSize).ToArray();
var envelopeKeyToEncrypt = EnvelopeKeyForDataKey(aesObject.Key);
var cipher = RsaUtils.CreateRsaOaepSha1Cipher(true, rsa);
var encryptedEnvelopeKey = cipher.DoFinal(envelopeKeyToEncrypt);
var instructions = new EncryptionInstructions(materials.MaterialsDescription, aesObject.Key, encryptedEnvelopeKey, nonce,
XAmzWrapAlgRsaOaepSha1, XAmzAesGcmCekAlgValue);
return instructions;
}
default:
{
throw new NotSupportedException($"{materials.AsymmetricProviderType} isn't supported with AsymmetricProvider");
}
}
}
/// <summary>
/// Returns encryption instructions to encrypt content with AES/GCM/NoPadding algorithm
/// Creates encryption key used for AES/GCM/NoPadding and encrypt it with AES/GCM
/// Encrypted key follows nonce(12 bytes) + key cipher text(16 or 32 bytes) + tag(16 bytes) format
/// Tag is appended by the AES/GCM cipher with encryption process
/// </summary>
/// <param name="materials"></param>
/// <returns></returns>
private static EncryptionInstructions EncryptEnvelopeKeyUsingSymmetricKeyV2(EncryptionMaterialsV2 materials)
{
var aes = materials.SymmetricProvider as Aes;
if (aes == null)
{
throw new NotSupportedException("AES is the only supported algorithm with this method.");
}
switch (materials.SymmetricProviderType)
{
case SymmetricAlgorithmType.AesGcm:
{
var aesObject = Aes.Create();
var nonce = aesObject.IV.Take(DefaultNonceSize).ToArray();
var associatedText = Encoding.UTF8.GetBytes(XAmzAesGcmCekAlgValue);
var cipher = AesGcmUtils.CreateCipher(true, materials.SymmetricProvider.Key, DefaultTagBitsLength, nonce, associatedText);
var envelopeKey = cipher.DoFinal(aesObject.Key);
var encryptedEnvelopeKey = nonce.Concat(envelopeKey).ToArray();
var instructions = new EncryptionInstructions(materials.MaterialsDescription, aesObject.Key, encryptedEnvelopeKey, nonce,
XAmzWrapAlgAesGcmValue, XAmzAesGcmCekAlgValue);
return instructions;
}
default:
{
throw new NotSupportedException($"{materials.SymmetricProviderType} isn't supported with SymmetricProvider");
}
}
}
/// <summary>
/// Bundle envelope key with key length and CEK algorithm information
/// Format: (1 byte is length of the key) + (envelope key) + (UTF-8 encoding of CEK algorithm)
/// </summary>
/// <param name="dataKey">Data key to be bundled</param>
/// <returns></returns>
private static byte[] EnvelopeKeyForDataKey(byte[] dataKey)
{
var cekAlgorithm = Encoding.UTF8.GetBytes(XAmzAesGcmCekAlgValue);
int length = 1 + dataKey.Length + cekAlgorithm.Length;
var envelopeKeyToEncrypt = new byte[length];
envelopeKeyToEncrypt[0] = (byte)dataKey.Length;
dataKey.CopyTo(envelopeKeyToEncrypt, 1);
cekAlgorithm.CopyTo(envelopeKeyToEncrypt, 1 + dataKey.Length);
return envelopeKeyToEncrypt;
}
/// <summary>
/// Update the request's ObjectMetadata with the necessary information for decrypting the object.
/// </summary>
/// <param name="request">
/// AmazonWebServiceRequest encrypted using the given instruction
/// </param>
/// <param name="instructions">
/// Non-null instruction used to encrypt the data in this AmazonWebServiceRequest .
/// </param>
/// <param name="encryptionClient">Encryption client used for put objects</param>
internal static void UpdateMetadataWithEncryptionInstructionsV2(AmazonWebServiceRequest request,
EncryptionInstructions instructions, AmazonS3EncryptionClientBase encryptionClient)
{
var keyBytesToStoreInMetadata = instructions.EncryptedEnvelopeKey;
var base64EncodedEnvelopeKey = Convert.ToBase64String(keyBytesToStoreInMetadata);
var ivToStoreInMetadata = instructions.InitializationVector;
var base64EncodedIv = Convert.ToBase64String(ivToStoreInMetadata);
MetadataCollection metadata = null;
var putObjectRequest = request as PutObjectRequest;
if (putObjectRequest != null)
metadata = putObjectRequest.Metadata;
var initiateMultipartrequest = request as InitiateMultipartUploadRequest;
if (initiateMultipartrequest != null)
metadata = initiateMultipartrequest.Metadata;
if (metadata != null)
{
metadata.Add(XAmzWrapAlg, instructions.WrapAlgorithm);
metadata.Add(XAmzTagLen, DefaultTagBitsLength.ToString());
metadata.Add(XAmzKeyV2, base64EncodedEnvelopeKey);
metadata.Add(XAmzCekAlg, instructions.CekAlgorithm);
metadata.Add(XAmzIV, base64EncodedIv);
metadata.Add(XAmzMatDesc, JsonMapper.ToJson(instructions.MaterialsDescription));
}
}
internal static PutObjectRequest CreateInstructionFileRequestV2(AmazonWebServiceRequest request, EncryptionInstructions instructions)
{
var keyBytesToStoreInInstructionFile = instructions.EncryptedEnvelopeKey;
var base64EncodedEnvelopeKey = Convert.ToBase64String(keyBytesToStoreInInstructionFile);
var ivToStoreInInstructionFile = instructions.InitializationVector;
var base64EncodedIv = Convert.ToBase64String(ivToStoreInInstructionFile);
var jsonData = new JsonData
{
[XAmzTagLen] = DefaultTagBitsLength.ToString(),
[XAmzKeyV2] = base64EncodedEnvelopeKey,
[XAmzCekAlg] = instructions.CekAlgorithm,
[XAmzWrapAlg] = instructions.WrapAlgorithm,
[XAmzIV] = base64EncodedIv,
[XAmzMatDesc] = JsonMapper.ToJson(instructions.MaterialsDescription)
};
var contentBody = jsonData.ToJson();
var putObjectRequest = request as PutObjectRequest;
if (putObjectRequest != null)
{
return GetInstructionFileRequest(putObjectRequest.BucketName, putObjectRequest.Key, EncryptionInstructionFileV2Suffix, contentBody);
}
var completeMultiPartRequest = request as CompleteMultipartUploadRequest;
if (completeMultiPartRequest != null)
{
return GetInstructionFileRequest(completeMultiPartRequest.BucketName, completeMultiPartRequest.Key, EncryptionInstructionFileV2Suffix, contentBody);
}
return null;
}
private static PutObjectRequest GetInstructionFileRequest(string bucketName, string key, string suffix, string contentBody)
{
var instructionFileRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"{key}{suffix}",
ContentBody = contentBody
};
instructionFileRequest.Metadata.Add(XAmzCryptoInstrFile, "");
return instructionFileRequest;
}
/// <summary>
/// Returns an updated input stream where the input stream contains the encrypted object contents.
/// The specified instruction will be used to encrypt data.
/// </summary>
/// <param name="toBeEncrypted">
/// The stream whose contents are to be encrypted.
/// </param>
/// <param name="instructions">
/// The instruction that will be used to encrypt the object data.
/// </param>
/// <returns>
/// Encrypted stream, i.e input stream wrapped into encrypted stream
/// </returns>
internal static Stream EncryptUploadPartRequestUsingInstructionsV2(Stream toBeEncrypted, EncryptionInstructions instructions)
{
//wrap input stream into AesGcmEncryptCachingStream wrapper
Stream aesGcmEncryptStream = new AesGcmEncryptCachingStream(toBeEncrypted, instructions.EnvelopeKey, instructions.InitializationVector, DefaultTagBitsLength);
return aesGcmEncryptStream;
}
/// <summary>
/// Generates an instruction that will be used to encrypt an object
/// using materials with the KMSKeyID set.
/// </summary>
/// <param name="kmsClient">
/// Used to call KMS to generate a data key.
/// </param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt data.
/// </param>
/// <returns>
/// The instruction that will be used to encrypt an object.
/// </returns>
internal static EncryptionInstructions GenerateInstructionsForKMSMaterialsV2(IAmazonKeyManagementService kmsClient, EncryptionMaterialsV2 materials)
{
if (materials.KMSKeyID == null)
{
throw new ArgumentNullException(nameof(materials.KMSKeyID), KmsKeyIdNullMessage);
}
switch (materials.KmsType)
{
case KmsType.KmsContext:
{
var nonce = new byte[DefaultNonceSize];
// Generate nonce, and get both the key and the encrypted key from KMS.
RandomNumberGenerator.Create().GetBytes(nonce);
var result = kmsClient.GenerateDataKey(materials.KMSKeyID, materials.MaterialsDescription, KMSKeySpec);
var instructions = new EncryptionInstructions(materials.MaterialsDescription, result.KeyPlaintext, result.KeyCiphertext, nonce,
XAmzWrapAlgKmsContextValue, XAmzAesGcmCekAlgValue);
return instructions;
}
default:
throw new NotSupportedException($"{materials.KmsType} is not supported for KMS Key Id {materials.KMSKeyID}");
}
}
#if AWS_ASYNC_API
/// <summary>
/// Generates an instruction that will be used to encrypt an object
/// using materials with the KMSKeyID set.
/// </summary>
/// <param name="kmsClient">
/// Used to call KMS to generate a data key.
/// </param>
/// <param name="materials">
/// The encryption materials to be used to encrypt and decrypt data.
/// </param>
/// <returns>
/// The instruction that will be used to encrypt an object.
/// </returns>
internal static async System.Threading.Tasks.Task<EncryptionInstructions> GenerateInstructionsForKMSMaterialsV2Async(IAmazonKeyManagementService kmsClient,
EncryptionMaterialsV2 materials)
{
if (materials.KMSKeyID == null)
{
throw new ArgumentNullException(nameof(materials.KMSKeyID), KmsKeyIdNullMessage);
}
switch (materials.KmsType)
{
case KmsType.KmsContext:
{
var nonce = new byte[DefaultNonceSize];
// Generate nonce, and get both the key and the encrypted key from KMS.
RandomNumberGenerator.Create().GetBytes(nonce);
var result = await kmsClient.GenerateDataKeyAsync(materials.KMSKeyID, materials.MaterialsDescription, KMSKeySpec).ConfigureAwait(false);
var instructions = new EncryptionInstructions(materials.MaterialsDescription, result.KeyPlaintext, result.KeyCiphertext, nonce,
XAmzWrapAlgKmsContextValue, XAmzAesGcmCekAlgValue);
return instructions;
}
default:
throw new NotSupportedException($"{materials.KmsType} is not supported for KMS Key Id {materials.KMSKeyID}");
}
}
#endif
/// <summary>
/// Converts x-amz-matdesc JSON string to dictionary
/// </summary>
/// <param name="metadata">Metadata that contains x-amz-matdesc key</param>
/// <returns></returns>
internal static Dictionary<string, string> GetMaterialDescriptionFromMetaData(MetadataCollection metadata)
{
var materialDescriptionJsonString = metadata[XAmzMatDesc];
if (materialDescriptionJsonString == null)
{
return new Dictionary<string, string>();
}
var materialDescription = JsonMapper.ToObject<Dictionary<string, string>>(materialDescriptionJsonString);
return materialDescription;
}
internal static GetObjectRequest GetInstructionFileRequestV2(GetObjectResponse response)
{
var request = new GetObjectRequest
{
BucketName = response.BucketName,
Key = response.Key + EncryptionInstructionFileV2Suffix
};
return request;
}
/// <summary>
/// Build encryption instructions for UploadPartEncryptionContext
/// </summary>
/// <param name="context">UploadPartEncryptionContext which contains instructions used for encrypting multipart object</param>
/// <param name="encryptionMaterials">EncryptionMaterials which contains material used for encrypting multipart object</param>
/// <returns></returns>
internal static EncryptionInstructions BuildEncryptionInstructionsForInstructionFileV2(UploadPartEncryptionContext context, EncryptionMaterialsBase encryptionMaterials)
{
var instructions = new EncryptionInstructions(encryptionMaterials.MaterialsDescription, context.EnvelopeKey, context.EncryptedEnvelopeKey, context.FirstIV,
context.WrapAlgorithm, context.CekAlgorithm);
return instructions;
}
/// <summary>
/// Builds an instruction object from the instruction file.
/// </summary>
/// <param name="response"> Instruction file GetObject response</param>
/// <param name="materials">
/// The non-null encryption materials to be used to encrypt and decrypt Envelope key.
/// </param>
/// <returns>
/// A non-null instruction object containing encryption information.
/// </returns>
internal static EncryptionInstructions BuildInstructionsUsingInstructionFileV2(GetObjectResponse response, EncryptionMaterialsBase materials)
{
using (TextReader textReader = new StreamReader(response.ResponseStream))
{
var jsonData = JsonMapper.ToObject(textReader);
if (jsonData[XAmzKeyV2] != null)
{
// The envelope contains data in V2 format
var encryptedEnvelopeKey = Base64DecodedDataValue(jsonData, XAmzKeyV2);
var decryptedEnvelopeKey = DecryptNonKmsEnvelopeKeyV2(encryptedEnvelopeKey, materials);
var initializationVector = Base64DecodedDataValue(jsonData, XAmzIV);
var materialDescription = JsonMapper.ToObject<Dictionary<string, string>>((string)jsonData[XAmzMatDesc]);
var cekAlgorithm = StringValue(jsonData, XAmzCekAlg);
var wrapAlgorithm = StringValue(jsonData, XAmzWrapAlg);
var instructions = new EncryptionInstructions(materialDescription, decryptedEnvelopeKey, null,
initializationVector, wrapAlgorithm, cekAlgorithm);
return instructions;
}
else if (jsonData[XAmzKey] != null)
{
// The envelope contains data in V1 format
var encryptedEnvelopeKey = Base64DecodedDataValue(jsonData, XAmzKey);
var decryptedEnvelopeKey = DecryptNonKMSEnvelopeKey(encryptedEnvelopeKey, materials);
var initializationVector = Base64DecodedDataValue(jsonData, XAmzIV);
var materialDescription = JsonMapper.ToObject<Dictionary<string, string>>((string)jsonData[XAmzMatDesc]);
var instructions = new EncryptionInstructions(materialDescription, decryptedEnvelopeKey, null, initializationVector);
return instructions;
}
else if (jsonData[EncryptedEnvelopeKey] != null)
{
// The envelope contains data in older format
var encryptedEnvelopeKey = Base64DecodedDataValue(jsonData, EncryptedEnvelopeKey);
var decryptedEnvelopeKey = DecryptNonKMSEnvelopeKey(encryptedEnvelopeKey, materials);
var initializationVector = Base64DecodedDataValue(jsonData, IV);
return new EncryptionInstructions(materials.MaterialsDescription, decryptedEnvelopeKey, initializationVector);
}
else
{
throw new ArgumentException("Missing parameters required for decryption");
}
}
}
private static byte[] Base64DecodedDataValue(JsonData jsonData, string key)
{
var base64EncodedValue = jsonData[key];
if (base64EncodedValue == null)
{
throw new ArgumentNullException(nameof(key));
}
return Convert.FromBase64String((string)base64EncodedValue);
}
private static string StringValue(JsonData jsonData, string key)
{
var stringValue = jsonData[key];
if (stringValue == null)
{
throw new ArgumentNullException(nameof(key));
}
return (string)stringValue;
}
}
}
| 554 |
amazon-s3-encryption-client-dotnet | aws | C# | namespace Amazon.Extensions.S3.Encryption
{
/// <summary>
/// SecurityProfile enables AmazonS3EncryptionClientV2 downgrading to AmazonS3EncryptionClient (V1) content encryption and key wrap schemas
/// V2AndLegacy enables AmazonS3EncryptionClientV2 to read objects encrypted by AmazonS3EncryptionClient (V1)
/// </summary>
public enum SecurityProfile
{
/// <summary>
/// Enables AmazonS3EncryptionClientV2 key wrap and content encryption schemas
/// which are only supported by AmazonS3EncryptionClientV2
/// </summary>
V2,
/// <summary>
/// Enables AmazonS3EncryptionClient (V1) & AmazonS3EncryptionClientV2 key wrap and content encryption schemas
/// With this mode, AmazonS3EncryptionClientV2 can read objects encrypted by AmazonS3EncryptionClient (V1) client.
/// </summary>
V2AndLegacy
}
} | 21 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.IO;
namespace Amazon.Extensions.S3.Encryption
{
internal class UploadPartEncryptionContext
{
public CryptoStorageMode StorageMode { get; set; }
public byte[] EncryptedEnvelopeKey { get; set; }
public byte[] EnvelopeKey { get; set; }
public byte[] FirstIV { get; set; }
public byte[] NextIV { get; set; }
public bool IsFinalPart { get; set; }
public int PartNumber { get; set; }
/// <summary>
/// Content encryption algorithm used for upload part
/// </summary>
public string CekAlgorithm { get; set; }
/// <summary>
/// Key encryption algorithm used for upload part
/// </summary>
public string WrapAlgorithm { get; set; }
/// <summary>
/// Keep track of the AES GCM stream instance
/// Reinitializing the stream for every upload part will re-calculate the tag
/// which will corrupt the data
/// </summary>
public Stream CryptoStream { get; set; }
}
}
| 49 |
amazon-s3-encryption-client-dotnet | aws | C# | using System;
using System.Collections.Generic;
using System.Linq;
using Amazon.Runtime;
using Amazon.S3.Model;
using Amazon.Runtime.Internal;
using Amazon.S3;
using GetObjectResponse = Amazon.S3.Model.GetObjectResponse;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Custom the pipeline handler to decrypt objects.
/// </summary>
public abstract class SetupDecryptionHandler : PipelineHandler
{
/// <summary>
/// Construct instance of SetupDecryptionHandler.
/// </summary>
/// <param name="encryptionClient"></param>
public SetupDecryptionHandler(AmazonS3EncryptionClientBase encryptionClient)
{
this.EncryptionClient = encryptionClient;
}
/// <summary>
/// Gets the EncryptionClient property which is the AmazonS3EncryptionClientBase that is decrypting the object.
/// </summary>
public AmazonS3EncryptionClientBase EncryptionClient
{
get;
private set;
}
/// <summary>
/// Calls the post invoke logic after calling the next handler
/// in the pipeline.
/// </summary>
/// <param name="executionContext">The execution context which contains both the
/// requests and response context.</param>
public override void InvokeSync(IExecutionContext executionContext)
{
base.InvokeSync(executionContext);
PostInvoke(executionContext);
}
/// <summary>
/// Decrypt the object being downloaded.
/// </summary>
/// <param name="executionContext"></param>
protected void PostInvoke(IExecutionContext executionContext)
{
byte[] encryptedKMSEnvelopeKey;
Dictionary<string, string> encryptionContext;
byte[] decryptedEnvelopeKeyKMS = null;
if (KMSEnvelopeKeyIsPresent(executionContext, out encryptedKMSEnvelopeKey, out encryptionContext))
{
#if BCL
decryptedEnvelopeKeyKMS = DecryptedEnvelopeKeyKms(encryptedKMSEnvelopeKey, encryptionContext);
#else
decryptedEnvelopeKeyKMS = DecryptedEnvelopeKeyKmsAsync(encryptedKMSEnvelopeKey, encryptionContext).GetAwaiter().GetResult();
#endif
}
var getObjectResponse = executionContext.ResponseContext.Response as GetObjectResponse;
if (getObjectResponse != null)
{
#if BCL
DecryptObject(decryptedEnvelopeKeyKMS, getObjectResponse);
#else
DecryptObjectAsync(decryptedEnvelopeKeyKMS, getObjectResponse).GetAwaiter().GetResult();
#endif
}
var completeMultiPartUploadRequest = executionContext.RequestContext.Request.OriginalRequest as CompleteMultipartUploadRequest;
var completeMultipartUploadResponse = executionContext.ResponseContext.Response as CompleteMultipartUploadResponse;
if (completeMultipartUploadResponse != null)
{
#if BCL
CompleteMultipartUpload(completeMultiPartUploadRequest);
#else
CompleteMultipartUploadAsync(completeMultiPartUploadRequest).GetAwaiter().GetResult();
#endif
}
PostInvokeSynchronous(executionContext, decryptedEnvelopeKeyKMS);
}
#if BCL
/// <summary>
/// Decrypts envelope key using KMS client
/// </summary>
/// <param name="encryptedKMSEnvelopeKey">Encrypted key byte array to be decrypted</param>
/// <param name="encryptionContext">Encryption context for KMS</param>
/// <returns></returns>
protected abstract byte[] DecryptedEnvelopeKeyKms(byte[] encryptedKMSEnvelopeKey, Dictionary<string, string> encryptionContext);
#endif
#if AWS_ASYNC_API
/// <summary>
/// Decrypts envelope key using KMS client asynchronously
/// </summary>
/// <param name="encryptedKMSEnvelopeKey">Encrypted key byte array to be decrypted</param>
/// <param name="encryptionContext">Encryption context for KMS</param>
/// <returns></returns>
protected abstract System.Threading.Tasks.Task<byte[]> DecryptedEnvelopeKeyKmsAsync(byte[] encryptedKMSEnvelopeKey, Dictionary<string, string> encryptionContext);
#endif
#if AWS_ASYNC_API
/// <summary>
/// Calls the and post invoke logic after calling the next handler
/// in the pipeline.
/// </summary>
/// <typeparam name="T">The response type for the current request.</typeparam>
/// <param name="executionContext">The execution context, it contains the
/// request and response context.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
public override async System.Threading.Tasks.Task<T> InvokeAsync<T>(IExecutionContext executionContext)
{
var response = await base.InvokeAsync<T>(executionContext).ConfigureAwait(false);
await PostInvokeAsync(executionContext).ConfigureAwait(false);
return response;
}
/// <summary>
/// Decrypt the object being downloaded.
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
protected async System.Threading.Tasks.Task PostInvokeAsync(IExecutionContext executionContext)
{
byte[] encryptedKMSEnvelopeKey;
Dictionary<string, string> encryptionContext;
byte[] decryptedEnvelopeKeyKMS = null;
if (KMSEnvelopeKeyIsPresent(executionContext, out encryptedKMSEnvelopeKey, out encryptionContext))
{
decryptedEnvelopeKeyKMS = await DecryptedEnvelopeKeyKmsAsync(encryptedKMSEnvelopeKey, encryptionContext).ConfigureAwait(false);
}
var getObjectResponse = executionContext.ResponseContext.Response as GetObjectResponse;
if (getObjectResponse != null)
{
await DecryptObjectAsync(decryptedEnvelopeKeyKMS, getObjectResponse).ConfigureAwait(false);
}
var completeMultiPartUploadRequest = executionContext.RequestContext.Request.OriginalRequest as CompleteMultipartUploadRequest;
var completeMultipartUploadResponse = executionContext.ResponseContext.Response as CompleteMultipartUploadResponse;
if (completeMultipartUploadResponse != null)
{
await CompleteMultipartUploadAsync(completeMultiPartUploadRequest).ConfigureAwait(false);
}
PostInvokeSynchronous(executionContext, decryptedEnvelopeKeyKMS);
}
/// <summary>
/// Mark multipart upload operation as completed and free resources asynchronously
/// </summary>
/// <param name="completeMultiPartUploadRequest">CompleteMultipartUploadRequest request which needs to marked as completed</param>
/// <returns></returns>
protected abstract System.Threading.Tasks.Task CompleteMultipartUploadAsync(CompleteMultipartUploadRequest completeMultiPartUploadRequest);
/// <summary>
/// Decrypt GetObjectResponse asynchronously
/// Find which mode of encryption is used which can be either metadata (including KMS) or instruction file mode and
/// use these instructions to decrypt GetObjectResponse asynchronously
/// </summary>
/// <param name="decryptedEnvelopeKeyKMS">decrypted envelope key for KMS</param>
/// <param name="getObjectResponse">GetObjectResponse which needs to be decrypted</param>
/// <returns></returns>
/// <exception cref="AmazonServiceException">Exception thrown if GetObjectResponse decryption fails</exception>
protected async System.Threading.Tasks.Task DecryptObjectAsync(byte[] decryptedEnvelopeKeyKMS, GetObjectResponse getObjectResponse)
{
if (EncryptionUtils.IsEncryptionInfoInMetadata(getObjectResponse))
{
DecryptObjectUsingMetadata(getObjectResponse, decryptedEnvelopeKeyKMS);
}
else
{
GetObjectResponse instructionFileResponse = null;
try
{
var instructionFileRequest = EncryptionUtils.GetInstructionFileRequest(getObjectResponse, EncryptionUtils.EncryptionInstructionFileV2Suffix);
instructionFileResponse = await GetInstructionFileAsync(instructionFileRequest).ConfigureAwait(false);
}
catch (AmazonS3Exception amazonS3Exception) when (amazonS3Exception.ErrorCode == EncryptionUtils.NoSuchKey)
{
Logger.InfoFormat($"New instruction file with suffix {EncryptionUtils.EncryptionInstructionFileV2Suffix} doesn't exist. " +
$"Try to get old instruction file with suffix {EncryptionUtils.EncryptionInstructionFileSuffix}. {amazonS3Exception.Message}");
try
{
var instructionFileRequest = EncryptionUtils.GetInstructionFileRequest(getObjectResponse, EncryptionUtils.EncryptionInstructionFileSuffix);
instructionFileResponse = await GetInstructionFileAsync(instructionFileRequest).ConfigureAwait(false);
}
catch (AmazonServiceException ace)
{
throw new AmazonServiceException($"Unable to decrypt data for object {getObjectResponse.Key} in bucket {getObjectResponse.BucketName}", ace);
}
}
catch (AmazonServiceException ace)
{
throw new AmazonServiceException($"Unable to decrypt data for object {getObjectResponse.Key} in bucket {getObjectResponse.BucketName}", ace);
}
DecryptObjectUsingInstructionFile(getObjectResponse, instructionFileResponse);
}
}
private async System.Threading.Tasks.Task<GetObjectResponse> GetInstructionFileAsync(GetObjectRequest instructionFileRequest)
{
var instructionFileResponse = await EncryptionClient.S3ClientForInstructionFile.GetObjectAsync(instructionFileRequest)
.ConfigureAwait(false);
return instructionFileResponse;
}
#elif AWS_APM_API
/// <summary>
/// Calls the PostInvoke methods after calling the next handler
/// in the pipeline.
/// </summary>
/// <param name="executionContext">The execution context, it contains the
/// request and response context.</param>
protected override void InvokeAsyncCallback(IAsyncExecutionContext executionContext)
{
IExecutionContext syncExecutionContext = ExecutionContext.CreateFromAsyncContext(executionContext);
// Process the response if an exception hasn't occured
if (executionContext.ResponseContext.AsyncResult.Exception == null)
{
byte[] encryptedKMSEnvelopeKey;
Dictionary<string, string> encryptionContext;
if (KMSEnvelopeKeyIsPresent(syncExecutionContext, out encryptedKMSEnvelopeKey, out encryptionContext))
throw new NotSupportedException("The AWS SDK for .NET Framework 3.5 version of " +
EncryptionClient.GetType().Name + " does not support KMS key wrapping via the async programming model. " +
"Please use the synchronous version instead.");
var getObjectResponse = executionContext.ResponseContext.Response as GetObjectResponse;
if (getObjectResponse != null)
{
DecryptObject(encryptedKMSEnvelopeKey, getObjectResponse);
}
var completeMultiPartUploadRequest = executionContext.RequestContext.Request.OriginalRequest as CompleteMultipartUploadRequest;
var completeMultipartUploadResponse = executionContext.ResponseContext.Response as CompleteMultipartUploadResponse;
if (completeMultipartUploadResponse != null)
{
CompleteMultipartUpload(completeMultiPartUploadRequest);
}
PostInvokeSynchronous(syncExecutionContext, null);
}
base.InvokeAsyncCallback(executionContext);
}
#endif
/// <summary>
/// Verify whether envelope is KMS or not
/// Populate envelope key and encryption context
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
/// <param name="encryptedKMSEnvelopeKey">Encrypted KMS envelope key</param>
/// <param name="encryptionContext">KMS encryption context used for encryption and decryption</param>
/// <returns></returns>
protected bool KMSEnvelopeKeyIsPresent(IExecutionContext executionContext,
out byte[] encryptedKMSEnvelopeKey, out Dictionary<string, string> encryptionContext)
{
var response = executionContext.ResponseContext.Response;
var getObjectResponse = response as GetObjectResponse;
encryptedKMSEnvelopeKey = null;
encryptionContext = null;
if (getObjectResponse != null)
{
var metadata = getObjectResponse.Metadata;
EncryptionUtils.EnsureSupportedAlgorithms(metadata);
var base64EncodedEncryptedKmsEnvelopeKey = metadata[EncryptionUtils.XAmzKeyV2];
if (base64EncodedEncryptedKmsEnvelopeKey != null)
{
var wrapAlgorithm = metadata[EncryptionUtils.XAmzWrapAlg];
if (!(EncryptionUtils.XAmzWrapAlgKmsContextValue.Equals(wrapAlgorithm) || EncryptionUtils.XAmzWrapAlgKmsValue.Equals(wrapAlgorithm)))
{
return false;
}
encryptedKMSEnvelopeKey = Convert.FromBase64String(base64EncodedEncryptedKmsEnvelopeKey);
encryptionContext = EncryptionUtils.GetMaterialDescriptionFromMetaData(metadata);
return true;
}
}
return false;
}
/// <summary>
/// Decrypt the object being downloaded.
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
/// <param name="decryptedEnvelopeKeyKMS">Decrypted KMS envelope key</param>
protected void PostInvokeSynchronous(IExecutionContext executionContext, byte[] decryptedEnvelopeKeyKMS)
{
var request = executionContext.RequestContext.Request;
var response = executionContext.ResponseContext.Response;
var initiateMultiPartUploadRequest = request.OriginalRequest as InitiateMultipartUploadRequest;
var initiateMultiPartResponse = response as InitiateMultipartUploadResponse;
if (initiateMultiPartResponse != null)
{
AddMultipartUploadEncryptionContext(initiateMultiPartUploadRequest, initiateMultiPartResponse);
}
var uploadPartRequest = request.OriginalRequest as UploadPartRequest;
var uploadPartResponse = response as UploadPartResponse;
if (uploadPartResponse != null)
{
UpdateMultipartUploadEncryptionContext(uploadPartRequest);
}
var abortMultipartUploadRequest = request.OriginalRequest as AbortMultipartUploadRequest;
var abortMultipartUploadResponse = response as AbortMultipartUploadResponse;
if (abortMultipartUploadResponse != null)
{
//Clear Context data since encryption is aborted
EncryptionClient.CurrentMultiPartUploadKeys.TryRemove(abortMultipartUploadRequest.UploadId, out _);
}
}
#if BCL
/// <summary>
/// Mark multipart upload operation as completed and free resources
/// </summary>
/// <param name="completeMultiPartUploadRequest">CompleteMultipartUploadRequest request which needs to marked as completed</param>
/// <returns></returns>
protected abstract void CompleteMultipartUpload(CompleteMultipartUploadRequest completeMultiPartUploadRequest);
/// <summary>
/// Find mode of encryption and decrypt GetObjectResponse
/// </summary>
/// <param name="decryptedEnvelopeKeyKMS">decrypted envelope key for KMS</param>
/// <param name="getObjectResponse">GetObjectResponse which needs to be decrypted</param>
/// <returns></returns>
/// <exception cref="AmazonServiceException">Exception thrown if GetObjectResponse decryption fails</exception>
protected void DecryptObject(byte[] decryptedEnvelopeKeyKMS, GetObjectResponse getObjectResponse)
{
if (EncryptionUtils.IsEncryptionInfoInMetadata(getObjectResponse))
{
DecryptObjectUsingMetadata(getObjectResponse, decryptedEnvelopeKeyKMS);
}
else
{
GetObjectResponse instructionFileResponse = null;
try
{
var instructionFileRequest = EncryptionUtils.GetInstructionFileRequest(getObjectResponse, EncryptionUtils.EncryptionInstructionFileV2Suffix);
instructionFileResponse = GetInstructionFile(instructionFileRequest);
}
catch (AmazonS3Exception amazonS3Exception) when (amazonS3Exception.ErrorCode == EncryptionUtils.NoSuchKey)
{
Logger.InfoFormat($"New instruction file with suffix {EncryptionUtils.EncryptionInstructionFileV2Suffix} doesn't exist. " +
$"Try to get old instruction file with suffix {EncryptionUtils.EncryptionInstructionFileSuffix}. {amazonS3Exception.Message}");
try
{
var instructionFileRequest = EncryptionUtils.GetInstructionFileRequest(getObjectResponse, EncryptionUtils.EncryptionInstructionFileSuffix);
instructionFileResponse = GetInstructionFile(instructionFileRequest);
}
catch (AmazonServiceException ace)
{
throw new AmazonServiceException($"Unable to decrypt data for object {getObjectResponse.Key} in bucket {getObjectResponse.BucketName}", ace);
}
}
catch (AmazonServiceException ace)
{
throw new AmazonServiceException($"Unable to decrypt data for object {getObjectResponse.Key} in bucket {getObjectResponse.BucketName}", ace);
}
DecryptObjectUsingInstructionFile(getObjectResponse, instructionFileResponse);
}
}
private GetObjectResponse GetInstructionFile(GetObjectRequest instructionFileRequest)
{
var instructionFileResponse = EncryptionClient.S3ClientForInstructionFile.GetObject(instructionFileRequest);
return instructionFileResponse;
}
#endif
/// <summary>
/// Updates object where the object input stream contains the decrypted contents.
/// </summary>
/// <param name="getObjectResponse">The getObject response of InstructionFile.</param>
/// <param name="instructionFileResponse">The getObject response whose contents are to be decrypted.</param>
protected void DecryptObjectUsingInstructionFile(GetObjectResponse getObjectResponse, GetObjectResponse instructionFileResponse)
{
// Create an instruction object from the instruction file response
var instructions = EncryptionUtils.BuildInstructionsUsingInstructionFileV2(instructionFileResponse, EncryptionClient.EncryptionMaterials);
if (EncryptionUtils.XAmzAesGcmCekAlgValue.Equals(instructions.CekAlgorithm))
{
// Decrypt the object with V2 instructions
EncryptionUtils.DecryptObjectUsingInstructionsGcm(getObjectResponse, instructions);
}
else
{
ThrowIfLegacyReadIsDisabled();
// Decrypt the object with V1 instructions
EncryptionUtils.DecryptObjectUsingInstructions(getObjectResponse, instructions);
}
}
/// <summary>
/// Updates object where the object input stream contains the decrypted contents.
/// </summary>
/// <param name="getObjectResponse">The getObject response whose contents are to be decrypted.</param>
/// <param name="decryptedEnvelopeKeyKMS">The decrypted envelope key to be use if KMS key wrapping is being used. Or null if non-KMS key wrapping is being used.</param>
protected void DecryptObjectUsingMetadata(GetObjectResponse getObjectResponse, byte[] decryptedEnvelopeKeyKMS)
{
// Create an instruction object from the object metadata
EncryptionInstructions instructions = EncryptionUtils.BuildInstructionsFromObjectMetadata(getObjectResponse, EncryptionClient.EncryptionMaterials, decryptedEnvelopeKeyKMS);
if (decryptedEnvelopeKeyKMS != null)
{
// Check if encryption context is present for KMS+context (v2) objects
if (getObjectResponse.Metadata[EncryptionUtils.XAmzCekAlg] != null
&& instructions.MaterialsDescription.ContainsKey(EncryptionUtils.XAmzEncryptionContextCekAlg))
{
// If encryption context is present, ensure that the GCM algorithm name is in the EC as expected in v2
if (EncryptionUtils.XAmzAesGcmCekAlgValue.Equals(getObjectResponse.Metadata[EncryptionUtils.XAmzCekAlg])
&& EncryptionUtils.XAmzAesGcmCekAlgValue.Equals(instructions.MaterialsDescription[EncryptionUtils.XAmzEncryptionContextCekAlg]))
{
// Decrypt the object with V2 instruction
EncryptionUtils.DecryptObjectUsingInstructionsGcm(getObjectResponse, instructions);
}
else
{
throw new AmazonCryptoException($"The content encryption algorithm used at encryption time does not match the algorithm stored for decryption time." +
" The object may be altered or corrupted.");
}
}
// Handle legacy KMS (v1) mode with GCM content encryption
// See https://github.com/aws/amazon-s3-encryption-client-dotnet/issues/26 for context. It fixes AWS SES encryption/decryption bug
else if (EncryptionUtils.XAmzAesGcmCekAlgValue.Equals(instructions.CekAlgorithm))
{
// KMS (v1) without Encryption Context requires legacy mode to be enabled even when GCM is used for content encryption
ThrowIfLegacyReadIsDisabled();
EncryptionUtils.DecryptObjectUsingInstructionsGcm(getObjectResponse, instructions);
}
else if (EncryptionUtils.XAmzAesCbcPaddingCekAlgValue.Equals(instructions.CekAlgorithm))
{
ThrowIfLegacyReadIsDisabled();
// Decrypt the object with V1 instruction
EncryptionUtils.DecryptObjectUsingInstructions(getObjectResponse, instructions);
}
else
{
throw new AmazonCryptoException($"The content encryption algorithm used at encryption time does not match the algorithm stored for decryption time." +
" The object may be altered or corrupted.");
}
}
else if (EncryptionUtils.XAmzAesGcmCekAlgValue.Equals(getObjectResponse.Metadata[EncryptionUtils.XAmzCekAlg]))
{
// Decrypt the object with V2 instruction
EncryptionUtils.DecryptObjectUsingInstructionsGcm(getObjectResponse, instructions);
}
// It is safe to assume, this is either non KMS encryption with V1 client or AES CBC
// We don't need to check cek algorithm to be AES CBC, because non KMS encryption with V1 client doesn't set it
else
{
ThrowIfLegacyReadIsDisabled();
EncryptionUtils.DecryptObjectUsingInstructions(getObjectResponse, instructions);
}
}
/// <summary>
/// Throws if legacy security profile is disabled
/// </summary>
protected abstract void ThrowIfLegacyReadIsDisabled();
/// <summary>
/// Update multipart upload encryption context for the given UploadPartRequest
/// </summary>
/// <param name="uploadPartRequest">UploadPartRequest whose context needs to be updated</param>
protected abstract void UpdateMultipartUploadEncryptionContext(UploadPartRequest uploadPartRequest);
/// <summary>
/// Add multipart UploadId and encryption context to the current known multipart operations
/// Encryption context is used decided the encryption instructions for next UploadPartRequest
/// </summary>
/// <param name="initiateMultiPartUploadRequest">InitiateMultipartUploadRequest whose encryption context needs to be saved</param>
/// <param name="initiateMultiPartResponse">InitiateMultipartUploadResponse whose UploadId needs to be saved</param>
protected void AddMultipartUploadEncryptionContext(InitiateMultipartUploadRequest initiateMultiPartUploadRequest, InitiateMultipartUploadResponse initiateMultiPartResponse)
{
if (!EncryptionClient.AllMultiPartUploadRequestContexts.ContainsKey(initiateMultiPartUploadRequest))
{
throw new AmazonServiceException($"Failed to find encryption context required to start multipart uploads for request {initiateMultiPartUploadRequest}");
}
EncryptionClient.CurrentMultiPartUploadKeys.TryAdd(initiateMultiPartResponse.UploadId, EncryptionClient.AllMultiPartUploadRequestContexts[initiateMultiPartUploadRequest]);
// It is safe to remove the request as it has been already added to the CurrentMultiPartUploadKeys
EncryptionClient.AllMultiPartUploadRequestContexts.TryRemove(initiateMultiPartUploadRequest, out _);
}
}
}
| 507 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.S3.Model;
using System.IO;
using Amazon.KeyManagementService.Model;
using Amazon.Runtime.Internal.Util;
using Amazon.S3;
using ThirdParty.Json.LitJson;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Custom the pipeline handler to decrypt objects for AmazonS3EncryptionClient.
/// </summary>
public class SetupDecryptionHandlerV1 : SetupDecryptionHandler
{
private const string KMSKeyIDMetadataMessage = "Unable to determine the KMS key ID from the object metadata.";
/// <summary>
/// Encryption material containing cryptographic configuration information
/// </summary>
internal EncryptionMaterials EncryptionMaterials => (EncryptionMaterials)EncryptionClient.EncryptionMaterials;
/// <summary>
/// Construct an instance SetupEncryptionHandlerV1.
/// </summary>
/// <param name="encryptionClient">Encryption client used to put and get objects</param>
public SetupDecryptionHandlerV1(AmazonS3EncryptionClientBase encryptionClient) : base(encryptionClient)
{
}
private static string GetKmsKeyIdFromMetadata(MetadataCollection metadata)
{
var materialDescriptionJsonString = metadata[EncryptionUtils.XAmzMatDesc];
if (materialDescriptionJsonString == null)
{
throw new InvalidDataException( $"{KMSKeyIDMetadataMessage} The key '{EncryptionUtils.XAmzMatDesc}' is missing.");
}
else
{
JsonData materialDescriptionJsonData;
try
{
materialDescriptionJsonData = JsonMapper.ToObject(materialDescriptionJsonString);
}
catch (JsonException e)
{
throw new InvalidDataException($"{KMSKeyIDMetadataMessage} The key '{EncryptionUtils.XAmzMatDesc}' does not contain valid JSON.", e);
}
JsonData kmsKeyIDJsonData;
try
{
kmsKeyIDJsonData = materialDescriptionJsonData[EncryptionUtils.KMSCmkIDKey];
}
catch (JsonException e)
{
throw new InvalidDataException($"{KMSKeyIDMetadataMessage} The key '{EncryptionUtils.KMSCmkIDKey}' is does not contain valid JSON.", e);
}
if (kmsKeyIDJsonData == null)
{
throw new InvalidDataException($"{KMSKeyIDMetadataMessage} The key '{kmsKeyIDJsonData}' is missing from the material description.");
}
return kmsKeyIDJsonData.ToString();
}
}
#if BCL
/// <inheritdoc/>
protected override void CompleteMultipartUpload(CompleteMultipartUploadRequest completeMultiPartUploadRequest)
{
UploadPartEncryptionContext context = this.EncryptionClient.CurrentMultiPartUploadKeys[completeMultiPartUploadRequest.UploadId];
if (context.StorageMode == CryptoStorageMode.InstructionFile)
{
var instructions = EncryptionUtils.BuildEncryptionInstructionsForInstructionFile(context, EncryptionMaterials);
var instructionFileRequest = EncryptionUtils.CreateInstructionFileRequest(completeMultiPartUploadRequest, instructions);
this.EncryptionClient.S3ClientForInstructionFile.PutObject(instructionFileRequest);
}
//Clear Context data since encryption is completed
this.EncryptionClient.CurrentMultiPartUploadKeys.TryRemove(completeMultiPartUploadRequest.UploadId, out _);
}
/// <inheritdoc/>
protected override byte[] DecryptedEnvelopeKeyKms(byte[] encryptedKMSEnvelopeKey, Dictionary<string, string> encryptionContext)
{
var request = new DecryptRequest()
{
CiphertextBlob = new MemoryStream(encryptedKMSEnvelopeKey),
EncryptionContext = encryptionContext
};
var response = EncryptionClient.KMSClient.Decrypt(request);
return response.Plaintext.ToArray();
}
#endif
#if AWS_ASYNC_API
/// <inheritdoc/>
protected override async System.Threading.Tasks.Task CompleteMultipartUploadAsync(CompleteMultipartUploadRequest completeMultiPartUploadRequest)
{
UploadPartEncryptionContext context = this.EncryptionClient.CurrentMultiPartUploadKeys[completeMultiPartUploadRequest.UploadId];
if (context.StorageMode == CryptoStorageMode.InstructionFile)
{
var instructions = EncryptionUtils.BuildEncryptionInstructionsForInstructionFile(context, EncryptionMaterials);
var instructionFileRequest = EncryptionUtils.CreateInstructionFileRequest(completeMultiPartUploadRequest, instructions);
await EncryptionClient.S3ClientForInstructionFile.PutObjectAsync(instructionFileRequest)
.ConfigureAwait(false);
}
//Clear Context data since encryption is completed
this.EncryptionClient.CurrentMultiPartUploadKeys.TryRemove(completeMultiPartUploadRequest.UploadId, out _);
}
/// <inheritdoc />
protected override async System.Threading.Tasks.Task<byte[]> DecryptedEnvelopeKeyKmsAsync(byte[] encryptedKMSEnvelopeKey, Dictionary<string, string> encryptionContext)
{
var request = new DecryptRequest()
{
CiphertextBlob = new MemoryStream(encryptedKMSEnvelopeKey),
EncryptionContext = encryptionContext
};
var response = await EncryptionClient.KMSClient.DecryptAsync(request).ConfigureAwait(false);
return response.Plaintext.ToArray();
}
#endif
/// <inheritdoc />
protected override void ThrowIfLegacyReadIsDisabled()
{
// V1n doesn't need to throw any exception
}
/// <summary>
/// Update multipart upload encryption context for the given UploadPartRequest
/// </summary>
/// <param name="uploadPartRequest">UploadPartRequest whose context needs to be updated</param>
/// <exception cref="AmazonS3Exception">Exception throw if fails to update the encryption context</exception>
protected override void UpdateMultipartUploadEncryptionContext(UploadPartRequest uploadPartRequest)
{
string uploadID = uploadPartRequest.UploadId;
UploadPartEncryptionContext encryptedUploadedContext = null;
if (!this.EncryptionClient.CurrentMultiPartUploadKeys.TryGetValue(uploadID, out encryptedUploadedContext))
throw new AmazonS3Exception("Encryption context for multipart upload not found");
if (!uploadPartRequest.IsLastPart)
{
object stream = null;
if (!((Amazon.Runtime.Internal.IAmazonWebServiceRequest) uploadPartRequest).RequestState.TryGetValue(AmazonS3EncryptionClient.S3CryptoStream, out stream))
throw new AmazonS3Exception("Cannot retrieve S3 crypto stream from request state, hence cannot get Initialization vector for next uploadPart ");
var encryptionStream = stream as AESEncryptionUploadPartStream;
if (encryptionStream != null)
{
encryptedUploadedContext.NextIV = encryptionStream.InitializationVector;
}
}
}
}
}
| 183 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.IO;
using Amazon.Extensions.S3.Encryption.Util;
using Amazon.KeyManagementService.Model;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Util;
using Amazon.S3;
using Amazon.S3.Model;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Custom the pipeline handler to decrypt objects for AmazonS3EncryptionClientV2.
/// </summary>
public class SetupDecryptionHandlerV2 : SetupDecryptionHandler
{
/// <summary>
/// Encryption material containing cryptographic configuration information
/// </summary>
internal EncryptionMaterialsV2 EncryptionMaterials => (EncryptionMaterialsV2)EncryptionClient.EncryptionMaterials;
/// <summary>
/// Crypto configuration of the encryption client
/// </summary>
internal AmazonS3CryptoConfigurationV2 CryptoConfiguration => EncryptionClient.S3CryptoConfig as AmazonS3CryptoConfigurationV2;
/// <summary>
/// Construct an instance SetupEncryptionHandlerV2.
/// </summary>
/// <param name="encryptionClient"></param>
public SetupDecryptionHandlerV2(AmazonS3EncryptionClientBase encryptionClient) : base(encryptionClient)
{
}
#if BCL
/// <inheritdoc/>
protected override byte[] DecryptedEnvelopeKeyKms(byte[] encryptedKMSEnvelopeKey, Dictionary<string, string> encryptionContext)
{
var request = new DecryptRequest()
{
KeyId = EncryptionClient.EncryptionMaterials.KMSKeyID,
CiphertextBlob = new MemoryStream(encryptedKMSEnvelopeKey),
EncryptionContext = encryptionContext
};
var response = EncryptionClient.KMSClient.Decrypt(request);
return response.Plaintext.ToArray();
}
/// <inheritdoc/>
protected override void CompleteMultipartUpload(CompleteMultipartUploadRequest completeMultiPartUploadRequest)
{
UploadPartEncryptionContext context = EncryptionClient.CurrentMultiPartUploadKeys[completeMultiPartUploadRequest.UploadId];
if (context.StorageMode == CryptoStorageMode.InstructionFile)
{
var instructions = EncryptionUtils.BuildEncryptionInstructionsForInstructionFileV2(context, EncryptionMaterials);
var instructionFileRequest = EncryptionUtils.CreateInstructionFileRequestV2(completeMultiPartUploadRequest, instructions);
EncryptionClient.S3ClientForInstructionFile.PutObject(instructionFileRequest);
}
//Clear Context data since encryption is completed
EncryptionClient.CurrentMultiPartUploadKeys.TryRemove(completeMultiPartUploadRequest.UploadId, out _);
}
#endif
#if AWS_ASYNC_API
/// <inheritdoc />
protected override async System.Threading.Tasks.Task<byte[]> DecryptedEnvelopeKeyKmsAsync(byte[] encryptedKMSEnvelopeKey, Dictionary<string, string> encryptionContext)
{
var request = new DecryptRequest()
{
KeyId = EncryptionClient.EncryptionMaterials.KMSKeyID,
CiphertextBlob = new MemoryStream(encryptedKMSEnvelopeKey),
EncryptionContext = encryptionContext
};
var response = await EncryptionClient.KMSClient.DecryptAsync(request).ConfigureAwait(false);
return response.Plaintext.ToArray();
}
/// <inheritdoc/>
protected override async System.Threading.Tasks.Task CompleteMultipartUploadAsync(CompleteMultipartUploadRequest completeMultiPartUploadRequest)
{
UploadPartEncryptionContext context = EncryptionClient.CurrentMultiPartUploadKeys[completeMultiPartUploadRequest.UploadId];
if (context.StorageMode == CryptoStorageMode.InstructionFile)
{
var instructions = EncryptionUtils.BuildEncryptionInstructionsForInstructionFileV2(context, EncryptionMaterials);
PutObjectRequest instructionFileRequest = EncryptionUtils.CreateInstructionFileRequestV2(completeMultiPartUploadRequest, instructions);
await EncryptionClient.S3ClientForInstructionFile.PutObjectAsync(instructionFileRequest).ConfigureAwait(false);
}
//Clear Context data since encryption is completed
EncryptionClient.CurrentMultiPartUploadKeys.TryRemove(completeMultiPartUploadRequest.UploadId, out _);
}
#endif
/// <inheritdoc />
protected override void ThrowIfLegacyReadIsDisabled()
{
if (CryptoConfiguration.SecurityProfile == SecurityProfile.V2)
{
throw new AmazonCryptoException($"The requested object is encrypted with V1 encryption schemas that have been disabled by client configuration {nameof(SecurityProfile.V2)}." +
$" Retry with {nameof(SecurityProfile.V2AndLegacy)} enabled or reencrypt the object.");
}
}
/// <inheritdoc/>
protected override void UpdateMultipartUploadEncryptionContext(UploadPartRequest uploadPartRequest)
{
string uploadID = uploadPartRequest.UploadId;
UploadPartEncryptionContext encryptedUploadedContext = null;
if (!EncryptionClient.CurrentMultiPartUploadKeys.TryGetValue(uploadID, out encryptedUploadedContext))
throw new AmazonS3Exception("Encryption context for multipart upload not found");
if (!uploadPartRequest.IsLastPart)
{
object stream = null;
if (!((IAmazonWebServiceRequest) uploadPartRequest).RequestState.TryGetValue(AmazonS3EncryptionClient.S3CryptoStream, out stream))
throw new AmazonS3Exception("Cannot retrieve S3 crypto stream from request state, hence cannot get Initialization vector for next uploadPart ");
var encryptionStream = stream as AESEncryptionUploadPartStream;
if (encryptionStream != null)
{
encryptedUploadedContext.NextIV = encryptionStream.InitializationVector;
}
var aesGcmEncryptStream = stream as AesGcmEncryptStream;
if (aesGcmEncryptStream != null)
{
encryptedUploadedContext.CryptoStream = aesGcmEncryptStream;
}
}
}
}
}
| 156 |
amazon-s3-encryption-client-dotnet | aws | C# | using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.S3.Model;
using Amazon.Runtime.Internal;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Custom pipeline handler to encrypt the data as it is being uploaded to S3.
/// </summary>
public abstract class SetupEncryptionHandler : PipelineHandler
{
/// <summary>
/// Construct an instance SetupEncryptionHandler.
/// </summary>
/// <param name="encryptionClient"></param>
public SetupEncryptionHandler(AmazonS3EncryptionClientBase encryptionClient)
{
this.EncryptionClient = encryptionClient;
}
/// <summary>
/// Gets the EncryptionClient property which is the AmazonS3EncryptionClient that is encrypting the object.
/// </summary>
public AmazonS3EncryptionClientBase EncryptionClient
{
get;
private set;
}
/// <summary>
/// Calls pre invoke logic before calling the next handler
/// in the pipeline.
/// </summary>
/// <param name="executionContext">The execution context which contains both the
/// requests and response context.</param>
public override void InvokeSync(IExecutionContext executionContext)
{
PreInvoke(executionContext);
base.InvokeSync(executionContext);
}
/// <summary>
/// Encrypts the S3 object being uploaded.
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
protected void PreInvoke(IExecutionContext executionContext)
{
ThrowIfRangeGet(executionContext);
var instructions = GenerateInstructions(executionContext);
var putObjectRequest = executionContext.RequestContext.OriginalRequest as PutObjectRequest;
if (putObjectRequest != null)
{
#if BCL
EncryptObject(instructions, putObjectRequest);
#else
EncryptObjectAsync(instructions, putObjectRequest).GetAwaiter().GetResult();
#endif
}
PreInvokeSynchronous(executionContext, instructions);
}
#if BCL
private void EncryptObject(EncryptionInstructions instructions, PutObjectRequest putObjectRequest)
{
ValidateConfigAndMaterials();
if (EncryptionClient.S3CryptoConfig.StorageMode == CryptoStorageMode.ObjectMetadata)
{
GenerateEncryptedObjectRequestUsingMetadata(putObjectRequest, instructions);
}
else
{
var instructionFileRequest = GenerateEncryptedObjectRequestUsingInstructionFile(putObjectRequest, instructions);
EncryptionClient.S3ClientForInstructionFile.PutObject(instructionFileRequest);
}
}
#endif
/// <summary>
/// Updates the request where the instruction file contains encryption information
/// and the input stream contains the encrypted object contents.
/// </summary>
/// <param name="putObjectRequest">The request whose contents are to be encrypted.</param>
/// <param name="instructions">EncryptionInstructions instructions used for creating encrypt stream</param>
protected abstract PutObjectRequest GenerateEncryptedObjectRequestUsingInstructionFile(PutObjectRequest putObjectRequest, EncryptionInstructions instructions);
/// <summary>
/// Updates the request where the metadata contains encryption information
/// and the input stream contains the encrypted object contents.
/// </summary>
/// <param name="putObjectRequest">The request whose contents are to be encrypted.</param>
/// <param name="instructions">EncryptionInstructions instructions used for creating encrypt stream</param>
protected abstract void GenerateEncryptedObjectRequestUsingMetadata(PutObjectRequest putObjectRequest, EncryptionInstructions instructions);
/// <summary>
/// Generate encryption instructions
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
/// <returns>EncryptionInstructions to be used for encryption</returns>
protected abstract EncryptionInstructions GenerateInstructions(IExecutionContext executionContext);
#if AWS_ASYNC_API
/// <summary>
/// Calls pre invoke logic before calling the next handler
/// in the pipeline.
/// </summary>
/// <typeparam name="T">The response type for the current request.</typeparam>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
public override async System.Threading.Tasks.Task<T> InvokeAsync<T>(IExecutionContext executionContext)
{
await PreInvokeAsync(executionContext).ConfigureAwait(false);
return await base.InvokeAsync<T>(executionContext).ConfigureAwait(false);
}
/// <summary>
/// Encrypts the S3 object being uploaded.
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
protected async System.Threading.Tasks.Task PreInvokeAsync(IExecutionContext executionContext)
{
ThrowIfRangeGet(executionContext);
EncryptionInstructions instructions = await GenerateInstructionsAsync(executionContext).ConfigureAwait(false);
var request = executionContext.RequestContext.OriginalRequest;
var putObjectRequest = request as PutObjectRequest;
if (putObjectRequest != null)
{
await EncryptObjectAsync(instructions, putObjectRequest).ConfigureAwait(false);
}
PreInvokeSynchronous(executionContext, instructions);
}
private async System.Threading.Tasks.Task EncryptObjectAsync(EncryptionInstructions instructions, PutObjectRequest putObjectRequest)
{
ValidateConfigAndMaterials();
if (EncryptionClient.S3CryptoConfig.StorageMode == CryptoStorageMode.ObjectMetadata)
{
GenerateEncryptedObjectRequestUsingMetadata(putObjectRequest, instructions);
}
else
{
var instructionFileRequest = GenerateEncryptedObjectRequestUsingInstructionFile(putObjectRequest, instructions);
await EncryptionClient.S3ClientForInstructionFile.PutObjectAsync(instructionFileRequest)
.ConfigureAwait(false);
}
}
/// <summary>
/// Generate encryption instructions asynchronously
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
/// <returns>EncryptionInstructions to be used for encryption</returns>
protected abstract System.Threading.Tasks.Task<EncryptionInstructions> GenerateInstructionsAsync(IExecutionContext executionContext);
#elif AWS_APM_API
/// <summary>
/// Calls pre invoke logic before calling the next handler
/// in the pipeline.
/// </summary>
/// <param name="executionContext">The execution context which contains both the
/// requests and response context.</param>
/// <returns>IAsyncResult which represent an async operation.</returns>
public override IAsyncResult InvokeAsync(IAsyncExecutionContext executionContext)
{
IExecutionContext syncExecutionContext = ExecutionContext.CreateFromAsyncContext(executionContext);
ThrowIfRangeGet(syncExecutionContext);
if (NeedToGenerateKMSInstructions(syncExecutionContext))
throw new NotSupportedException("The AWS SDK for .NET Framework 3.5 version of " +
EncryptionClient.GetType().Name + " does not support KMS key wrapping via the async programming model. " +
"Please use the synchronous version instead.");
var instructions = GenerateInstructions(syncExecutionContext);
var putObjectRequest = syncExecutionContext.RequestContext.OriginalRequest as PutObjectRequest;
if (putObjectRequest != null)
{
EncryptObject(instructions, putObjectRequest);
}
PreInvokeSynchronous(syncExecutionContext, instructions);
return base.InvokeAsync(executionContext);
}
#endif
protected bool NeedToGenerateKMSInstructions(IExecutionContext executionContext)
{
return EncryptionClient.EncryptionMaterials.KMSKeyID != null &&
NeedToGenerateInstructions(executionContext);
}
internal static bool NeedToGenerateInstructions(IExecutionContext executionContext)
{
var request = executionContext.RequestContext.OriginalRequest;
var putObjectRequest = request as PutObjectRequest;
var initiateMultiPartUploadRequest = request as InitiateMultipartUploadRequest;
return putObjectRequest != null || initiateMultiPartUploadRequest != null;
}
internal void PreInvokeSynchronous(IExecutionContext executionContext, EncryptionInstructions instructions)
{
var request = executionContext.RequestContext.OriginalRequest;
var useKMSKeyWrapping = this.EncryptionClient.EncryptionMaterials.KMSKeyID != null;
var initiateMultiPartUploadRequest = request as InitiateMultipartUploadRequest;
if (initiateMultiPartUploadRequest != null)
{
GenerateInitiateMultiPartUploadRequest(instructions, initiateMultiPartUploadRequest, useKMSKeyWrapping);
}
var uploadPartRequest = request as UploadPartRequest;
if (uploadPartRequest != null)
{
GenerateEncryptedUploadPartRequest(uploadPartRequest);
}
}
/// <summary>
/// Updates the request where the input stream contains the encrypted object contents.
/// </summary>
/// <param name="uploadPartRequest">UploadPartRequest whose input stream needs to updated</param>
protected abstract void GenerateEncryptedUploadPartRequest(UploadPartRequest uploadPartRequest);
/// <summary>
/// Update InitiateMultipartUploadRequest request with given encryption instructions
/// </summary>
/// <param name="instructions">EncryptionInstructions which used for encrypting the UploadPartRequest request</param>
/// <param name="initiateMultiPartUploadRequest">InitiateMultipartUploadRequest whose encryption context needs to updated</param>
/// <param name="useKmsKeyWrapping">If true, KMS mode of encryption is used</param>
protected abstract void GenerateInitiateMultiPartUploadRequest(EncryptionInstructions instructions, InitiateMultipartUploadRequest initiateMultiPartUploadRequest, bool useKmsKeyWrapping);
/// <summary>
/// Make sure that the storage mode and encryption materials are compatible.
/// The client only supports KMS key wrapping in metadata storage mode.
/// </summary>
internal void ValidateConfigAndMaterials()
{
var usingKMSKeyWrapping = this.EncryptionClient.EncryptionMaterials.KMSKeyID != null;
var usingMetadataStorageMode = EncryptionClient.S3CryptoConfig.StorageMode == CryptoStorageMode.ObjectMetadata;
if (usingKMSKeyWrapping && !usingMetadataStorageMode)
throw new AmazonClientException($"{EncryptionClient.GetType().Name} only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.");
}
/// <summary>
/// Throws an exception if attempting a range GET with an encryption client
/// </summary>
/// <param name="executionContext">The execution context, it contains the request and response context.</param>
internal void ThrowIfRangeGet(IExecutionContext executionContext)
{
var getObjectRequest = executionContext.RequestContext.OriginalRequest as GetObjectRequest;
if (getObjectRequest != null && getObjectRequest.ByteRange != null)
{
throw new NotSupportedException("Unable to perform range get request: Range get is not supported. " +
$"See {EncryptionUtils.SDKEncryptionDocsUrl}");
}
}
}
}
| 271 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Runtime;
using Amazon.S3.Model;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Custom pipeline handler to encrypt the data as it is being uploaded to S3 for AmazonS3EncryptionClientV1.
/// </summary>
public class SetupEncryptionHandlerV1 : SetupEncryptionHandler
{
/// <summary>
/// Encryption material containing cryptographic configuration information
/// </summary>
internal EncryptionMaterials EncryptionMaterials => (EncryptionMaterials)EncryptionClient.EncryptionMaterials;
/// <summary>
/// Construct an instance SetupEncryptionHandlerV1.
/// </summary>
/// <param name="encryptionClient"></param>
public SetupEncryptionHandlerV1(AmazonS3EncryptionClientBase encryptionClient) : base(encryptionClient)
{
}
/// <inheritdoc/>
protected override EncryptionInstructions GenerateInstructions(IExecutionContext executionContext)
{
EncryptionInstructions instructions = null;
if (NeedToGenerateKMSInstructions(executionContext))
{
instructions = EncryptionUtils.GenerateInstructionsForKMSMaterials(EncryptionClient.KMSClient, EncryptionMaterials);
}
if (instructions == null && NeedToGenerateInstructions(executionContext))
{
instructions = EncryptionUtils.GenerateInstructionsForNonKMSMaterials(EncryptionMaterials);
}
return instructions;
}
#if AWS_ASYNC_API
/// <inheritdoc/>
protected override async System.Threading.Tasks.Task<EncryptionInstructions> GenerateInstructionsAsync(IExecutionContext executionContext)
{
EncryptionInstructions instructions = null;
if (NeedToGenerateKMSInstructions(executionContext))
{
instructions = await EncryptionUtils.GenerateInstructionsForKMSMaterialsAsync(
EncryptionClient.KMSClient, EncryptionMaterials).ConfigureAwait(false);
}
if (instructions == null && NeedToGenerateInstructions(executionContext))
{
instructions = EncryptionUtils.GenerateInstructionsForNonKMSMaterials(EncryptionMaterials);
}
return instructions;
}
#endif
/// <inheritdoc/>
protected override void GenerateEncryptedObjectRequestUsingMetadata(PutObjectRequest putObjectRequest, EncryptionInstructions instructions)
{
EncryptionUtils.AddUnencryptedContentLengthToMetadata(putObjectRequest);
// Encrypt the object data with the instruction
putObjectRequest.InputStream = EncryptionUtils.EncryptRequestUsingInstruction(putObjectRequest.InputStream, instructions);
// Update the metadata
EncryptionUtils.UpdateMetadataWithEncryptionInstructions(putObjectRequest, instructions,
EncryptionMaterials.KMSKeyID != null);
}
/// <inheritdoc/>
protected override PutObjectRequest GenerateEncryptedObjectRequestUsingInstructionFile(PutObjectRequest putObjectRequest, EncryptionInstructions instructions)
{
EncryptionUtils.AddUnencryptedContentLengthToMetadata(putObjectRequest);
// Encrypt the object data with the instruction
putObjectRequest.InputStream = EncryptionUtils.EncryptRequestUsingInstruction(putObjectRequest.InputStream, instructions);
// Create request for uploading instruction file
PutObjectRequest instructionFileRequest = EncryptionUtils.CreateInstructionFileRequest(putObjectRequest, instructions);
return instructionFileRequest;
}
/// <inheritdoc/>
protected override void GenerateInitiateMultiPartUploadRequest(EncryptionInstructions instructions, InitiateMultipartUploadRequest initiateMultiPartUploadRequest, bool useKMSKeyWrapping)
{
ValidateConfigAndMaterials();
if (EncryptionClient.S3CryptoConfig.StorageMode == CryptoStorageMode.ObjectMetadata)
{
EncryptionUtils.UpdateMetadataWithEncryptionInstructions(initiateMultiPartUploadRequest, instructions, useKMSKeyWrapping);
}
var context = new UploadPartEncryptionContext
{
StorageMode = EncryptionClient.S3CryptoConfig.StorageMode,
EncryptedEnvelopeKey = instructions.EncryptedEnvelopeKey,
EnvelopeKey = instructions.EnvelopeKey,
NextIV = instructions.InitializationVector,
FirstIV = instructions.InitializationVector,
PartNumber = 0,
WrapAlgorithm = instructions.WrapAlgorithm,
CekAlgorithm = instructions.CekAlgorithm,
};
EncryptionClient.AllMultiPartUploadRequestContexts[initiateMultiPartUploadRequest] = context;
}
/// <inheritdoc/>
protected override void GenerateEncryptedUploadPartRequest(UploadPartRequest request)
{
string uploadID = request.UploadId;
UploadPartEncryptionContext contextForEncryption = this.EncryptionClient.CurrentMultiPartUploadKeys[uploadID];
byte[] envelopeKey = contextForEncryption.EnvelopeKey;
byte[] IV = contextForEncryption.NextIV;
EncryptionInstructions instructions = new EncryptionInstructions(EncryptionMaterials.MaterialsDescription, envelopeKey, IV);
if (!request.IsLastPart)
{
if (contextForEncryption.IsFinalPart)
throw new AmazonClientException("Last part has already been processed, cannot upload this as the last part");
if (request.PartNumber < contextForEncryption.PartNumber)
throw new AmazonClientException($"Upload Parts must be in correct sequence. Request part number {request.PartNumber} must be >= to {contextForEncryption.PartNumber}");
request.InputStream = EncryptionUtils.EncryptUploadPartRequestUsingInstructions(request.InputStream, instructions);
contextForEncryption.PartNumber = request.PartNumber;
}
else
{
request.InputStream = EncryptionUtils.EncryptRequestUsingInstruction(request.InputStream, instructions);
contextForEncryption.IsFinalPart = true;
}
((Amazon.Runtime.Internal.IAmazonWebServiceRequest)request).RequestState.Add(AmazonS3EncryptionClient.S3CryptoStream, request.InputStream);
}
}
}
| 160 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Extensions.S3.Encryption.Util;
using Amazon.Runtime;
using Amazon.S3.Model;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Custom pipeline handler to encrypt the data as it is being uploaded to S3 for AmazonS3EncryptionClientV2.
/// </summary>
public class SetupEncryptionHandlerV2 : SetupEncryptionHandler
{
/// <summary>
/// Encryption material containing cryptographic configuration information
/// </summary>
internal EncryptionMaterialsV2 EncryptionMaterials => (EncryptionMaterialsV2)EncryptionClient.EncryptionMaterials;
/// <summary>
/// Construct an instance SetupEncryptionHandlerV2.
/// </summary>
/// <param name="encryptionClient"></param>
public SetupEncryptionHandlerV2(AmazonS3EncryptionClientBase encryptionClient) : base(encryptionClient)
{
}
/// <inheritdoc/>
protected override EncryptionInstructions GenerateInstructions(IExecutionContext executionContext)
{
EncryptionInstructions instructions = null;
if (NeedToGenerateKMSInstructions(executionContext))
{
instructions = EncryptionUtils.GenerateInstructionsForKMSMaterialsV2(EncryptionClient.KMSClient, EncryptionMaterials);
}
if (instructions == null && NeedToGenerateInstructions(executionContext))
{
instructions = EncryptionUtils.GenerateInstructionsForNonKmsMaterialsV2(EncryptionMaterials);
}
return instructions;
}
/// <inheritdoc/>
protected override PutObjectRequest GenerateEncryptedObjectRequestUsingInstructionFile(PutObjectRequest putObjectRequest, EncryptionInstructions instructions)
{
EncryptionUtils.AddUnencryptedContentLengthToMetadata(putObjectRequest);
// Encrypt the object data with the instruction
putObjectRequest.InputStream = EncryptionUtils.EncryptRequestUsingInstructionV2(putObjectRequest.InputStream, instructions, putObjectRequest.CalculateContentMD5Header);
// Create request for uploading instruction file
PutObjectRequest instructionFileRequest = EncryptionUtils.CreateInstructionFileRequestV2(putObjectRequest, instructions);
return instructionFileRequest;
}
#if AWS_ASYNC_API
/// <inheritdoc/>
protected override async System.Threading.Tasks.Task<EncryptionInstructions> GenerateInstructionsAsync(IExecutionContext executionContext)
{
EncryptionInstructions instructions = null;
if (NeedToGenerateKMSInstructions(executionContext))
{
instructions = await EncryptionUtils.GenerateInstructionsForKMSMaterialsV2Async(EncryptionClient.KMSClient, EncryptionMaterials)
.ConfigureAwait(false);
}
if (instructions == null && NeedToGenerateInstructions(executionContext))
{
instructions = EncryptionUtils.GenerateInstructionsForNonKmsMaterialsV2(EncryptionMaterials);
}
return instructions;
}
#endif
/// <inheritdoc/>
protected override void GenerateEncryptedObjectRequestUsingMetadata(PutObjectRequest putObjectRequest, EncryptionInstructions instructions)
{
EncryptionUtils.AddUnencryptedContentLengthToMetadata(putObjectRequest);
// Encrypt the object data with the instruction
putObjectRequest.InputStream = EncryptionUtils.EncryptRequestUsingInstructionV2(putObjectRequest.InputStream, instructions, putObjectRequest.CalculateContentMD5Header);
// Update the metadata
EncryptionUtils.UpdateMetadataWithEncryptionInstructionsV2(putObjectRequest, instructions, EncryptionClient);
}
/// <inheritdoc/>
protected override void GenerateInitiateMultiPartUploadRequest(EncryptionInstructions instructions, InitiateMultipartUploadRequest initiateMultiPartUploadRequest, bool useKmsKeyWrapping)
{
ValidateConfigAndMaterials();
if (EncryptionClient.S3CryptoConfig.StorageMode == CryptoStorageMode.ObjectMetadata)
{
EncryptionUtils.UpdateMetadataWithEncryptionInstructionsV2(initiateMultiPartUploadRequest, instructions, EncryptionClient);
}
var context = new UploadPartEncryptionContext
{
StorageMode = EncryptionClient.S3CryptoConfig.StorageMode,
EncryptedEnvelopeKey = instructions.EncryptedEnvelopeKey,
EnvelopeKey = instructions.EnvelopeKey,
FirstIV = instructions.InitializationVector,
NextIV = instructions.InitializationVector,
PartNumber = 0,
CekAlgorithm = instructions.CekAlgorithm,
WrapAlgorithm = instructions.WrapAlgorithm,
};
EncryptionClient.AllMultiPartUploadRequestContexts[initiateMultiPartUploadRequest] = context;
}
/// <inheritdoc/>
protected override void GenerateEncryptedUploadPartRequest(UploadPartRequest request)
{
string uploadID = request.UploadId;
var contextForEncryption = this.EncryptionClient.CurrentMultiPartUploadKeys[uploadID];
var envelopeKey = contextForEncryption.EnvelopeKey;
var IV = contextForEncryption.NextIV;
var instructions = new EncryptionInstructions(EncryptionMaterials.MaterialsDescription, envelopeKey, IV);
if (request.IsLastPart == false)
{
if (contextForEncryption.IsFinalPart)
throw new AmazonClientException("Last part has already been processed, cannot upload this as the last part");
if (request.PartNumber < contextForEncryption.PartNumber)
throw new AmazonClientException($"Upload Parts must be in correct sequence. Request part number {request.PartNumber} must be >= to {contextForEncryption.PartNumber}");
UpdateRequestInputStream(request, contextForEncryption, instructions);
contextForEncryption.PartNumber = request.PartNumber;
}
else
{
UpdateRequestInputStream(request, contextForEncryption, instructions);
contextForEncryption.IsFinalPart = true;
}
((Amazon.Runtime.Internal.IAmazonWebServiceRequest)request).RequestState.Add(AmazonS3EncryptionClient.S3CryptoStream, request.InputStream);
}
private static void UpdateRequestInputStream(UploadPartRequest request, UploadPartEncryptionContext contextForEncryption, EncryptionInstructions instructions)
{
if (contextForEncryption.CryptoStream == null)
{
request.InputStream = EncryptionUtils.EncryptUploadPartRequestUsingInstructionsV2(request.InputStream, instructions);
}
else
{
request.InputStream = contextForEncryption.CryptoStream;
}
// Clear the buffer filled for retry request
var aesGcmEncryptCachingStream = request.InputStream as AesGcmEncryptCachingStream;
if (aesGcmEncryptCachingStream != null)
{
aesGcmEncryptCachingStream.ClearReadBufferToPosition();
}
}
}
}
| 176 |
amazon-s3-encryption-client-dotnet | aws | C# | using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Util;
namespace Amazon.Extensions.S3.Encryption.Internal
{
/// <summary>
/// Adds the crypto token to the user agent
/// </summary>
public class UserAgentHandler : PipelineHandler
{
private string _userAgentSuffix;
/// <summary>
/// Construct instance of UserAgentHandler.
/// </summary>
public UserAgentHandler() : this("S3Crypto")
{
}
/// <summary>
/// Construct instance of UserAgentHandler with specified user agent suffix.
/// </summary>
/// <param name="userAgentSuffix">User agent prefix to be used for the encryption client</param>
public UserAgentHandler(string userAgentSuffix)
{
_userAgentSuffix = userAgentSuffix;
}
/// <summary>
/// Calls pre invoke logic before calling the next handler
/// in the pipeline.
/// </summary>
/// <param name="executionContext">The execution context which contains both the
/// requests and response context.</param>
public override void InvokeSync(IExecutionContext executionContext)
{
PreInvoke(executionContext);
base.InvokeSync(executionContext);
}
#if AWS_ASYNC_API
/// <summary>
/// Calls pre invoke logic before calling the next handler
/// in the pipeline.
/// </summary>
/// <typeparam name="T">The response type for the current request.</typeparam>
/// <param name="executionContext">The execution context, it contains the
/// request and response context.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
public override System.Threading.Tasks.Task<T> InvokeAsync<T>(IExecutionContext executionContext)
{
PreInvoke(executionContext);
return base.InvokeAsync<T>(executionContext);
}
#elif AWS_APM_API
/// <summary>
/// Calls pre invoke logic before calling the next handler
/// in the pipeline.
/// </summary>
/// <param name="executionContext">The execution context which contains both the
/// requests and response context.</param>
/// <returns>IAsyncResult which represent an async operation.</returns>
public override IAsyncResult InvokeAsync(IAsyncExecutionContext executionContext)
{
PreInvoke(ExecutionContext.CreateFromAsyncContext(executionContext));
return base.InvokeAsync(executionContext);
}
#endif
/// <summary>
/// Customize the user agent.
/// </summary>
/// <param name="executionContext"></param>
protected virtual void PreInvoke(IExecutionContext executionContext)
{
var request = executionContext.RequestContext.Request;
string currentUserAgent = request.Headers[AWSSDKUtils.UserAgentHeader];
request.Headers[AWSSDKUtils.UserAgentHeader] = $"{currentUserAgent} {_userAgentSuffix}";
}
}
}
| 90 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
namespace Amazon.Extensions.S3.Encryption.Primitives
{
/// <summary>
/// Type of public key and private key pair based crypto algorithms
/// </summary>
public enum AsymmetricAlgorithmType
{
/// <summary>
/// RSA encryption using OAEP padding
/// SHA-1 as the hash for MGF1 & OAEP
/// </summary>
RsaOaepSha1
}
} | 29 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
namespace Amazon.Extensions.S3.Encryption.Primitives
{
/// <summary>
/// Type of AWS Key Management Service key encryption type
/// </summary>
public enum KmsType
{
/// <summary>
/// A single secret encryption key with customer provided encryption context
/// </summary>
KmsContext
}
} | 28 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
namespace Amazon.Extensions.S3.Encryption.Primitives
{
/// <summary>
/// Type of single key based crypto algorithms
/// </summary>
public enum SymmetricAlgorithmType
{
/// <summary>
/// Represents an Advanced Encryption Standard (AES) key to be used with the Galois/Counter Mode (GCM) mode of operation.
/// </summary>
AesGcm
}
} | 28 |
amazon-s3-encryption-client-dotnet | aws | C# | /*******************************************************************************
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
* __ _ _ ___
* ( )( \/\/ )/ __)
* /__\ \ / \__ \
* (_)(_) \/\/ (___/
*
* AWS SDK for .NET
*
*/
using System.IO;
using Amazon.Runtime.Internal.Util;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Crypto.IO;
namespace Amazon.Extensions.S3.Encryption.Util
{
/// <summary>
/// A wrapper stream that decrypts the base stream using AES GCM algorithm as it
/// is being read.
/// </summary>
public class AesGcmDecryptStream : DecryptStream
{
/// <summary>
/// Constructor for initializing decryption stream
/// </summary>
/// <param name="baseStream">Original data stream</param>
/// <param name="key">Key to be used for decryption</param>
/// <param name="nonce">Nonce to be used for decryption</param>
/// <param name="tagSize">Tag size for the tag appended in the end of the stream</param>
/// <param name="associatedText">Additional associated data</param>
public AesGcmDecryptStream(Stream baseStream, byte[] key, byte[] nonce, int tagSize, byte[] associatedText = null)
: base(new CipherStream(baseStream, AesGcmUtils.CreateCipher(false, key, tagSize, nonce, associatedText), null))
{
}
/// <summary>
/// Reads a sequence of encrypted bytes from the current stream and advances the position
/// within the stream by the number of bytes read.
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes read from the current source.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be read from the current stream.
/// </param>
/// <returns>
/// The total number of bytes read into the buffer. This can be less than the
/// number of bytes requested if that many bytes are not currently available,
/// or zero (0) if the end of the stream has been reached.
/// </returns>
/// <exception cref="AmazonCryptoException">
/// Underlying crypto exception wrapped in Amazon exception
/// </exception>
public override int Read(byte[] buffer, int offset, int count)
{
try
{
return BaseStream.Read(buffer, offset, count);
}
catch (CryptoException cryptoException)
{
throw new AmazonCryptoException($"Failed to decrypt: {cryptoException.Message}", cryptoException);
}
}
#if AWS_ASYNC_API
/// <summary>
/// Asynchronously reads a sequence of decrypted bytes from the current stream, advances
/// the position within the stream by the number of bytes read, and monitors
/// cancellation requests.
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes read from the current source.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be read from the current stream.
/// </param>
/// <param name="cancellationToken">
/// The token to monitor for cancellation requests. The default value is
/// System.Threading.CancellationToken.None.
/// </param>
/// <returns>
/// A task that represents the asynchronous read operation. The value of the TResult
/// parameter contains the total number of bytes read into the buffer. This can be
/// less than the number of bytes requested if that many bytes are not currently
/// available, or zero (0) if the end of the stream has been reached.
/// </returns>
/// <exception cref="AmazonCryptoException">
/// Underlying crypto exception wrapped in Amazon exception
/// </exception>
public override async System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken)
{
try
{
var readBytes = await BaseStream.ReadAsync(buffer, offset, count, cancellationToken).ConfigureAwait(false);
return readBytes;
}
catch (CryptoException cryptoException)
{
throw new AmazonCryptoException($"Failed to decrypt: {cryptoException.Message}", cryptoException);
}
}
#endif
}
} | 129 |
amazon-s3-encryption-client-dotnet | aws | C# | /*******************************************************************************
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
* __ _ _ ___
* ( )( \/\/ )/ __)
* /__\ \ / \__ \
* (_)(_) \/\/ (___/
*
* AWS SDK for .NET
*
*/
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Crypto.IO;
namespace Amazon.Extensions.S3.Encryption.Util
{
/// <summary>
/// A wrapper stream that encrypts the base stream using AES GCM algorithm and caches the contents as it
/// is being read.
/// </summary>
public class AesGcmEncryptCachingStream : AesGcmEncryptStream
{
private long _position;
/// <summary>
/// Gets or sets the position within the current stream.
/// </summary>
public override long Position
{
get => _position;
set
{
if (value < _readBufferStartPosition || value > _position)
{
throw new NotSupportedException($"New position must be >= {_readBufferStartPosition} and <= {_position}");
}
_position = value;
}
}
/// <inheritdoc/>
public override bool CanSeek => true;
/// <summary>
/// Buffer to cache the read bytes
/// </summary>
private readonly List<byte> _readBuffer;
/// <summary>
/// Offset since _readBuffer has the read cache
/// </summary>
private long _readBufferStartPosition;
/// <summary>
/// Constructor for initializing encryption stream
/// </summary>
/// <param name="baseStream">Original data stream</param>
/// <param name="key">Key to be used for encryption</param>
/// <param name="nonce">Nonce to be used for encryption</param>
/// <param name="tagSize">Tag size for the tag appended in the end of the stream</param>
/// <param name="associatedText">Additional associated data</param>
public AesGcmEncryptCachingStream(Stream baseStream, byte[] key, byte[] nonce, int tagSize, byte[] associatedText = null)
: base(baseStream, key, nonce, tagSize, associatedText)
{
_readBuffer = new List<byte>();
}
/// <summary>
/// Reads and cache a sequence of encrypted bytes in _readBuffer from the current stream and advances the position
/// within the stream by the number of bytes read.
/// If current position lies in between lower bound and upper bound of _readBuffer, reads from the _readBuffer,
/// else read from the original stream
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes read from the current source.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be read from the current stream.
/// </param>
/// <returns>
/// The total number of bytes read into the buffer. This can be less than the
/// number of bytes requested if that many bytes are not currently available,
/// or zero (0) if the end of the stream has been reached.
/// </returns>
/// <exception cref="AmazonCryptoException">
/// Underlying crypto exception wrapped in Amazon exception
/// </exception>
public override int Read(byte[] buffer, int offset, int count)
{
var previousPosition = _position;
CopyFromReadBuffer(buffer, ref offset, ref count);
var readBytes = base.Read(buffer, offset, count);
AddReadBytesToReadBuffer(buffer, offset, readBytes);
return (int)(_position - previousPosition);
}
#if AWS_ASYNC_API
/// <summary>
/// Asynchronously reads and cache a sequence of encrypted bytes in _readBuffer from the current stream, advances
/// the position within the stream by the number of bytes read, and monitors
/// cancellation requests.
/// If current position lies in between lower bound and upper bound of _readBuffer, reads from the _readBuffer,
/// else read from the original stream
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes read from the current source.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be read from the current stream.
/// </param>
/// <param name="cancellationToken">
/// The token to monitor for cancellation requests. The default value is
/// System.Threading.CancellationToken.None.
/// </param>
/// <returns>
/// A task that represents the asynchronous read operation. The value of the TResult
/// parameter contains the total number of bytes read into the buffer. This can be
/// less than the number of bytes requested if that many bytes are not currently
/// available, or zero (0) if the end of the stream has been reached.
/// </returns>
/// <exception cref="AmazonCryptoException">
/// Underlying crypto exception wrapped in Amazon exception
/// </exception>
public override async System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken)
{
var previousPosition = _position;
CopyFromReadBuffer(buffer, ref offset, ref count);
var readBytes = await base.ReadAsync(buffer, offset, count, cancellationToken).ConfigureAwait(false);
AddReadBytesToReadBuffer(buffer, offset, readBytes);
return (int)(_position - previousPosition);
}
#endif
/// <summary>
/// Copies bytes to buffer if the current position lies between lower and upper bound of the _readBuffer and
/// advances the current position.
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes copied from the _readBuffer.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be copied from _readBuffer.
/// </param>
private void CopyFromReadBuffer(byte[] buffer, ref int offset, ref int count)
{
var readBufferOffset = (int)(_position - _readBufferStartPosition);
var bytesToCopy = Math.Min(_readBuffer.Count - readBufferOffset, count);
if (bytesToCopy == 0)
{
return;
}
_readBuffer.CopyTo(readBufferOffset, buffer, offset, bytesToCopy);
offset += bytesToCopy;
count -= bytesToCopy;
_position += bytesToCopy;
}
/// <summary>
/// Add read bytes to _readBuffer and advances the current position
/// </summary>
/// <param name="buffer">
/// An array of bytes containing read bytes</param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which read byte are stored
/// </param>
/// <param name="readBytes">
/// Total number of read bytes
/// </param>
private void AddReadBytesToReadBuffer(byte[] buffer, int offset, int readBytes)
{
if (readBytes == 0)
{
return;
}
_readBuffer.AddRange(buffer.Skip(offset).Take(readBytes));
_position += readBytes;
}
/// <summary>
/// Clear read bytes buffer before current position
/// </summary>
public void ClearReadBufferToPosition()
{
var bytesToRemove = (int)Math.Min(_position - _readBufferStartPosition, _readBuffer.Count);
_readBufferStartPosition = _position;
_readBuffer.RemoveRange(0, bytesToRemove);
}
}
}
| 229 |
amazon-s3-encryption-client-dotnet | aws | C# | /*******************************************************************************
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
* __ _ _ ___
* ( )( \/\/ )/ __)
* /__\ \ / \__ \
* (_)(_) \/\/ (___/
*
* AWS SDK for .NET
*
*/
using System;
using System.IO;
using Amazon.Runtime.Internal.Util;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Crypto.IO;
namespace Amazon.Extensions.S3.Encryption.Util
{
/// <summary>
/// A wrapper stream that encrypts the base stream using AES GCM algorithm as it
/// is being read.
/// </summary>
public class AesGcmEncryptStream : EncryptStream
{
private readonly long _length;
private long _position;
/// <summary>
/// Gets the length in bytes of the stream.
/// Length of the string is sum of nonce, cipher text and tag
/// </summary>
public override long Length => _length;
/// <summary>
/// Gets or sets the position within the current stream.
/// </summary>
public override long Position
{
get => _position;
set => throw new NotSupportedException();
}
/// <summary>
/// Constructor for initializing encryption stream
/// </summary>
/// <param name="baseStream">Original data stream</param>
/// <param name="key">Key to be used for encryption</param>
/// <param name="nonce">Nonce to be used for encryption</param>
/// <param name="tagSize">Tag size for the tag appended in the end of the stream</param>
/// <param name="associatedText">Additional associated data</param>
public AesGcmEncryptStream(Stream baseStream, byte[] key, byte[] nonce, int tagSize, byte[] associatedText = null)
: base(new CipherStream(baseStream, AesGcmUtils.CreateCipher(true, key, tagSize, nonce, associatedText), null))
{
_length = baseStream.Length + (tagSize / 8);
}
/// <summary>
/// Reads a sequence of encrypted bytes from the current stream and advances the position
/// within the stream by the number of bytes read.
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes read from the current source.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be read from the current stream.
/// </param>
/// <returns>
/// The total number of bytes read into the buffer. This can be less than the
/// number of bytes requested if that many bytes are not currently available,
/// or zero (0) if the end of the stream has been reached.
/// </returns>
/// <exception cref="AmazonCryptoException">
/// Underlying crypto exception wrapped in Amazon exception
/// </exception>
public override int Read(byte[] buffer, int offset, int count)
{
try
{
var readBytes = BaseStream.Read(buffer, offset, count);
_position += readBytes;
return readBytes;
}
catch (CryptoException cryptoException)
{
throw new AmazonCryptoException($"Failed to encrypt: {cryptoException.Message}", cryptoException);
}
}
#if AWS_ASYNC_API
/// <summary>
/// Asynchronously reads a sequence of encrypted bytes from the current stream, advances
/// the position within the stream by the number of bytes read, and monitors
/// cancellation requests.
/// </summary>
/// <param name="buffer">
/// An array of bytes. When this method returns, the buffer contains the specified
/// byte array with the values between offset and (offset + count - 1) replaced
/// by the bytes read from the current source.
/// </param>
/// <param name="offset">
/// The zero-based byte offset in buffer at which to begin storing the data read
/// from the current stream.
/// </param>
/// <param name="count">
/// The maximum number of bytes to be read from the current stream.
/// </param>
/// <param name="cancellationToken">
/// The token to monitor for cancellation requests. The default value is
/// System.Threading.CancellationToken.None.
/// </param>
/// <returns>
/// A task that represents the asynchronous read operation. The value of the TResult
/// parameter contains the total number of bytes read into the buffer. This can be
/// less than the number of bytes requested if that many bytes are not currently
/// available, or zero (0) if the end of the stream has been reached.
/// </returns>
/// <exception cref="AmazonCryptoException">
/// Underlying crypto exception wrapped in Amazon exception
/// </exception>
public override async System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken)
{
try
{
var readBytes = await BaseStream.ReadAsync(buffer, offset, count, cancellationToken).ConfigureAwait(false);;
_position += readBytes;
return readBytes;
}
catch (CryptoException cryptoException)
{
throw new AmazonCryptoException($"Failed to encrypt: {cryptoException.Message}", cryptoException);
}
}
#endif
}
}
| 153 |
amazon-s3-encryption-client-dotnet | aws | C# | using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Crypto.Engines;
using Org.BouncyCastle.Crypto.Modes;
using Org.BouncyCastle.Crypto.Parameters;
namespace Amazon.Extensions.S3.Encryption.Util
{
/// <summary>
/// Container of utilities methods for AES GCM encryption/decryption
/// </summary>
internal static class AesGcmUtils
{
/// <summary>
/// Create a buffered cipher to encrypt or decrypt a stream as it is being read
/// </summary>
/// <param name="forEncryption">forEncryption if true the cipher is initialised for encryption, if false for decryption</param>
/// <param name="key">Key to be used for encryption</param>
/// <param name="nonce">Nonce to be used for encryption</param>
/// <param name="tagSize">Tag size in bits for the tag appended in the end of the stream</param>
/// <param name="associatedText">Additional associated data</param>
/// <returns></returns>
internal static IBufferedCipher CreateCipher(bool forEncryption, byte[] key, int tagSize, byte[] nonce, byte[] associatedText)
{
var aesEngine = new AesEngine();
var blockCipher = new GcmBlockCipher(aesEngine);
var aeadBlockCipher = new BufferedAeadBlockCipher(blockCipher);
var parameters = new AeadParameters(new KeyParameter(key), tagSize, nonce, associatedText);
aeadBlockCipher.Init(forEncryption, parameters);
return aeadBlockCipher;
}
}
} | 32 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.Collections.Generic;
namespace Amazon.Extensions.S3.Encryption.Utils
{
internal class ConcurrentDictionary<KeyType, ValueType>
{
private readonly object _lock = new object();
private readonly Dictionary<KeyType, ValueType> _internalDictionary = new Dictionary<KeyType, ValueType>();
public ValueType this[KeyType key]
{
get
{
lock (_lock)
{
return _internalDictionary[key];
}
}
set
{
lock (_lock)
{
_internalDictionary[key] = value;
}
}
}
public bool TryGetValue(KeyType key, out ValueType value)
{
lock (_lock)
{
return _internalDictionary.TryGetValue(key, out value);
}
}
public bool ContainsKey(KeyType key)
{
lock (_lock)
{
return _internalDictionary.ContainsKey(key);
}
}
public bool TryAdd(KeyType key, ValueType value)
{
lock (_lock)
{
if (_internalDictionary.ContainsKey(key))
{
return false;
}
else
{
_internalDictionary.Add(key, value);
return true;
}
}
}
public bool TryRemove(KeyType key, out ValueType value)
{
lock (_lock)
{
if (_internalDictionary.ContainsKey(key))
{
value = _internalDictionary[key];
return _internalDictionary.Remove(key);
}
else
{
value = default;
return false;
}
}
}
}
} | 93 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright (c) 2000 - 2020 The Legion of the Bouncy Castle Inc. (https://www.bouncycastle.org)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this
* software and associated documentation files (the "Software"), to deal in the
* Software without restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies
* or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
* PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
* FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
using System.Security.Cryptography;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Crypto.Parameters;
using Org.BouncyCastle.Math;
namespace ThirdParty.Org.BouncyCastle.Security
{
/// <summary>
/// A class containing methods to interface the BouncyCastle world to the .NET Crypto world.
/// </summary>
public sealed class DotNetUtilities
{
public static RsaKeyParameters GetRsaPublicKey(RSA rsa)
{
return GetRsaPublicKey(rsa.ExportParameters(false));
}
public static RsaKeyParameters GetRsaPublicKey(RSAParameters rp)
{
return new RsaKeyParameters(
false,
new BigInteger(1, rp.Modulus),
new BigInteger(1, rp.Exponent));
}
public static AsymmetricCipherKeyPair GetRsaKeyPair(RSA rsa)
{
return GetRsaKeyPair(rsa.ExportParameters(true));
}
public static AsymmetricCipherKeyPair GetRsaKeyPair(RSAParameters rp)
{
BigInteger modulus = new BigInteger(1, rp.Modulus);
BigInteger pubExp = new BigInteger(1, rp.Exponent);
RsaKeyParameters pubKey = new RsaKeyParameters(
false,
modulus,
pubExp);
RsaPrivateCrtKeyParameters privKey = new RsaPrivateCrtKeyParameters(
modulus,
pubExp,
new BigInteger(1, rp.D),
new BigInteger(1, rp.P),
new BigInteger(1, rp.Q),
new BigInteger(1, rp.DP),
new BigInteger(1, rp.DQ),
new BigInteger(1, rp.InverseQ));
return new AsymmetricCipherKeyPair(pubKey, privKey);
}
}
}
| 76 |
amazon-s3-encryption-client-dotnet | aws | C# | using System.Security.Cryptography;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Crypto.Parameters;
using Org.BouncyCastle.Security;
using DotNetUtilities = ThirdParty.Org.BouncyCastle.Security.DotNetUtilities;
namespace Amazon.Extensions.S3.Encryption.Util
{
internal static class RsaUtils
{
/// <summary>
/// Creates Bouncy castle cipher using the .NET implementation of RSA
/// </summary>
/// <param name="forEncryption">forEncryption if true the cipher is initialised for encryption, if false for decryption</param>
/// <param name="rsa">.NET implementation of RSA symmetric algorithm</param>
/// <returns></returns>
internal static IBufferedCipher CreateRsaOaepSha1Cipher(bool forEncryption, RSA rsa)
{
var cipher = CipherUtilities.GetCipher("RSA/NONE/OAEPPadding");
if (forEncryption)
{
var rsaPublicKey = DotNetUtilities.GetRsaPublicKey(rsa);
cipher.Init(true, rsaPublicKey);
}
else
{
var asymmetricCipherKeyPair = DotNetUtilities.GetRsaKeyPair(rsa);
cipher.Init(false, asymmetricCipherKeyPair.Private);
}
return cipher;
}
}
}
| 35 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Security.Cryptography;
using System.IO;
using System.Text;
using System.Threading.Tasks;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.S3;
using Amazon.S3.Model;
using Xunit;
using Amazon.KeyManagementService;
using Amazon.KeyManagementService.Model;
using Amazon.Runtime.Internal.Util;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.NetStandard.Utilities;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV1InteropV1N : TestBase<AmazonS3Client>
{
private const string InstructionAndKmsErrorMessage = "AmazonS3EncryptionClient only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private const string SampleContent = "Encryption Client Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath = EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private string bucketName;
private string kmsKeyID;
private readonly KmsKeyIdProvider _kmsKeyIdProvider = new KmsKeyIdProvider();
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1;
#pragma warning disable 0618
private AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1N;
private AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1N;
#pragma warning restore 0618
public EncryptionTestsV1InteropV1N(KmsKeyIdProvider kmsKeyIdProvider) : base(kmsKeyIdProvider)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsIdAsync().GetAwaiter().GetResult();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(rsa);
var asymmetricEncryptionMaterialsV1N = new EncryptionMaterials(rsa);
var symmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(aes);
var symmetricEncryptionMaterialsV1N = new EncryptionMaterials(aes);
var kmsEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(kmsKeyID);
var kmsEncryptionMaterialsV1N = new EncryptionMaterials(kmsKeyID);
var configV1 = new Amazon.S3.Encryption.AmazonS3CryptoConfiguration()
{
StorageMode = Amazon.S3.Encryption.CryptoStorageMode.InstructionFile
};
var configV1N = new AmazonS3CryptoConfiguration()
{
StorageMode = CryptoStorageMode.InstructionFile
};
s3EncryptionClientMetadataModeAsymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeAsymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, asymmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeSymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeSymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, symmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeKMSV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(kmsEncryptionMaterialsV1);
s3EncryptionClientFileModeKMSV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, kmsEncryptionMaterialsV1);
#pragma warning disable 0618
s3EncryptionClientMetadataModeAsymmetricWrapV1N = new AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeAsymmetricWrapV1N = new AmazonS3EncryptionClient(configV1N, asymmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeSymmetricWrapV1N = new AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeSymmetricWrapV1N = new AmazonS3EncryptionClient(configV1N, symmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeKMSV1N = new AmazonS3EncryptionClient(kmsEncryptionMaterialsV1N);
s3EncryptionClientFileModeKMSV1N = new AmazonS3EncryptionClient(configV1N, kmsEncryptionMaterialsV1N);
#pragma warning restore 0618
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = EncryptionTestsUtils.CallAsyncTask(UtilityMethods.CreateBucketAsync(s3EncryptionClientFileModeAsymmetricWrapV1));
}
protected override void Dispose(bool disposing)
{
EncryptionTestsUtils.CallAsyncTask(UtilityMethods.DeleteBucketWithObjectsAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName));
s3EncryptionClientMetadataModeAsymmetricWrapV1.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeKMSV1.Dispose();
s3EncryptionClientFileModeKMSV1.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeKMSV1N.Dispose();
s3EncryptionClientFileModeKMSV1N.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N,s3EncryptionClientMetadataModeAsymmetricWrapV1,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV1,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV1,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV1,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, null, "", "", bucketName).ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV1,
null, null, "", "", bucketName).ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, null, null, "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV1,
null, null, null, "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1,
filePath, null, null, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N,
filePath, null, null, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1,
null, SampleContentBytes, null, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, null, "", "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, null, null, "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1,
null, null, SampleContent, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV1, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV1, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV1, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeKMS()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1, bucketName); });
}, InstructionAndKmsErrorMessage);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N, bucketName); });
}, InstructionAndKmsErrorMessage);
}
}
}
| 513 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.Runtime.Internal.Util;
using Amazon.S3;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.NetStandard.Utilities;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV1InteropV2 : TestBase<AmazonS3Client>
{
private const string InstructionAndKmsErrorMessage = "AmazonS3EncryptionClient only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private static readonly string LegacyReadWhenLegacyDisabledMessage = $"The requested object is encrypted with V1 encryption schemas that have been disabled by client configuration {nameof(SecurityProfile.V2)}." +
$" Retry with {nameof(SecurityProfile.V2AndLegacy)} enabled or reencrypt the object.";
private const string SampleContent = "Encryption Client Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath = EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private string bucketName;
private string kmsKeyID;
private AmazonS3CryptoConfigurationV2 fileConfigV2;
private AmazonS3CryptoConfigurationV2 metadataConfigV2;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1;
private Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeAsymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeAsymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeSymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeSymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeKMSV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeKMSV2;
public EncryptionTestsV1InteropV2(KmsKeyIdProvider kmsKeyIdProvider) : base(kmsKeyIdProvider)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsIdAsync().GetAwaiter().GetResult();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(rsa);
var asymmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(rsa, AsymmetricAlgorithmType.RsaOaepSha1);
var symmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(aes);
var symmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(aes, SymmetricAlgorithmType.AesGcm);
var kmsEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(kmsKeyID);
var kmsEncryptionMaterialsV2 = new EncryptionMaterialsV2(kmsKeyID, KmsType.KmsContext, new Dictionary<string, string>());
var configV1 = new Amazon.S3.Encryption.AmazonS3CryptoConfiguration
{
StorageMode = Amazon.S3.Encryption.CryptoStorageMode.InstructionFile
};
fileConfigV2 = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.InstructionFile,
};
metadataConfigV2 = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.ObjectMetadata
};
s3EncryptionClientMetadataModeAsymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeAsymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, asymmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeSymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeSymmetricWrapV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, symmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeKMSV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(kmsEncryptionMaterialsV1);
s3EncryptionClientFileModeKMSV1 = new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, kmsEncryptionMaterialsV1);
s3EncryptionClientMetadataModeAsymmetricWrapV2 = new AmazonS3EncryptionClientV2(metadataConfigV2, asymmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeAsymmetricWrapV2 = new AmazonS3EncryptionClientV2(fileConfigV2, asymmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeSymmetricWrapV2 = new AmazonS3EncryptionClientV2(metadataConfigV2, symmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeSymmetricWrapV2 = new AmazonS3EncryptionClientV2(fileConfigV2, symmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeKMSV2 = new AmazonS3EncryptionClientV2(metadataConfigV2, kmsEncryptionMaterialsV2);
s3EncryptionClientFileModeKMSV2 = new AmazonS3EncryptionClientV2(fileConfigV2, kmsEncryptionMaterialsV2);
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = EncryptionTestsUtils.CallAsyncTask(UtilityMethods.CreateBucketAsync(s3EncryptionClientFileModeAsymmetricWrapV1));
}
protected override void Dispose(bool disposing)
{
EncryptionTestsUtils.CallAsyncTask(UtilityMethods.DeleteBucketWithObjectsAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName));
s3EncryptionClientMetadataModeAsymmetricWrapV1.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeKMSV1.Dispose();
s3EncryptionClientFileModeKMSV1.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrapV2.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV2.Dispose();
s3EncryptionClientFileModeSymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeKMSV2.Dispose();
s3EncryptionClientFileModeKMSV2.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2,
filePath, null, null, SampleContent, bucketName));
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName); });
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2,
null, null, SampleContent, SampleContent, bucketName));
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeSymmetricWrapV1, s3EncryptionClientMetadataModeSymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeSymmetricWrapV1, s3EncryptionClientFileModeSymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeKMS()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2, bucketName));
}, InstructionAndKmsErrorMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingMetadataModeKMS_V2SecurityProfile()
{
metadataConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
filePath, null, null, SampleContent, bucketName)
);
}, LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap_V2SecurityProfile()
{
metadataConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1, s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
);
}, LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap_V2SecurityProfile()
{
fileConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1, s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
);
}, LegacyReadWhenLegacyDisabledMessage);
}
}
}
| 444 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.Runtime.Internal.Util;
using Amazon.S3;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.NetStandard.Utilities;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV1NInteropV2 : TestBase<AmazonS3Client>
{
private const string InstructionAndKMSErrorMessageV1N = "AmazonS3EncryptionClient only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private const string InstructionAndKMSErrorMessageV2 = "AmazonS3EncryptionClientV2 only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private static readonly string LegacyReadWhenLegacyDisabledMessage = $"The requested object is encrypted with V1 encryption schemas that have been disabled by client configuration {nameof(SecurityProfile.V2)}." +
$" Retry with {nameof(SecurityProfile.V2AndLegacy)} enabled or reencrypt the object.";
private const string SampleContent = "Encryption Client Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath = EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private string bucketName;
private string kmsKeyID;
private AmazonS3CryptoConfigurationV2 metadataConfigV2;
private AmazonS3CryptoConfigurationV2 fileConfigV2;
#pragma warning disable 0618
private AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1N;
private AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1N;
private AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1N;
#pragma warning restore 0618
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeAsymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeAsymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeSymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeSymmetricWrapV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeKMSV2;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeKMSV2;
public EncryptionTestsV1NInteropV2(KmsKeyIdProvider kmsKeyIdProvider) : base(kmsKeyIdProvider)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsIdAsync().GetAwaiter().GetResult();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterialsV1N = new EncryptionMaterials(rsa);
var symmetricEncryptionMaterialsV1N = new EncryptionMaterials(aes);
var kmsEncryptionMaterialsV1N = new EncryptionMaterials(kmsKeyID);
var configV1N = new AmazonS3CryptoConfiguration()
{
StorageMode = CryptoStorageMode.InstructionFile
};
var asymmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(rsa, AsymmetricAlgorithmType.RsaOaepSha1);
var symmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(aes, SymmetricAlgorithmType.AesGcm);
var kmsEncryptionMaterialsV2 = new EncryptionMaterialsV2(kmsKeyID, KmsType.KmsContext, new Dictionary<string, string>());
metadataConfigV2 = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.ObjectMetadata,
};
fileConfigV2 = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.InstructionFile,
};
#pragma warning disable 0618
s3EncryptionClientMetadataModeAsymmetricWrapV1N = new AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeAsymmetricWrapV1N = new AmazonS3EncryptionClient(configV1N, asymmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeSymmetricWrapV1N = new AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeSymmetricWrapV1N = new AmazonS3EncryptionClient(configV1N, symmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeKMSV1N = new AmazonS3EncryptionClient(kmsEncryptionMaterialsV1N);
s3EncryptionClientFileModeKMSV1N = new AmazonS3EncryptionClient(configV1N, kmsEncryptionMaterialsV1N);
#pragma warning restore 0618
s3EncryptionClientMetadataModeAsymmetricWrapV2 = new AmazonS3EncryptionClientV2(metadataConfigV2, asymmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeAsymmetricWrapV2 = new AmazonS3EncryptionClientV2(fileConfigV2, asymmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeSymmetricWrapV2 = new AmazonS3EncryptionClientV2(metadataConfigV2, symmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeSymmetricWrapV2 = new AmazonS3EncryptionClientV2(fileConfigV2, symmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeKMSV2 = new AmazonS3EncryptionClientV2(metadataConfigV2, kmsEncryptionMaterialsV2);
s3EncryptionClientFileModeKMSV2 = new AmazonS3EncryptionClientV2(fileConfigV2, kmsEncryptionMaterialsV2);
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = EncryptionTestsUtils.CallAsyncTask(UtilityMethods.CreateBucketAsync(s3EncryptionClientFileModeAsymmetricWrapV1N));
}
protected override void Dispose(bool disposing)
{
EncryptionTestsUtils.CallAsyncTask(UtilityMethods.DeleteBucketWithObjectsAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName));
s3EncryptionClientMetadataModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeKMSV1N.Dispose();
s3EncryptionClientFileModeKMSV1N.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrapV2.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV2.Dispose();
s3EncryptionClientFileModeSymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeKMSV2.Dispose();
s3EncryptionClientFileModeKMSV2.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV2, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV2, s3EncryptionClientMetadataModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV2, s3EncryptionClientFileModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV2, s3EncryptionClientFileModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV2, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV2, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV2, s3EncryptionClientFileModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV2, s3EncryptionClientFileModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV2, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV2, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV2, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, "", "", bucketName).ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV2, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, "", "", bucketName).ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV2, s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, null, "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV2, s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, null, "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV2, s3EncryptionClientFileModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV2, s3EncryptionClientFileModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N,
filePath, null, null, SampleContent, bucketName));
}, InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2,
filePath, null, null, SampleContent, bucketName));
}, InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetStreamUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName); });
}, InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => { return EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName); });
}, InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, null, SampleContent, SampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetZeroLengthContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, null, "", "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, null, "", "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void PutGetNullContentContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, null, null, "", bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, null, null, "", bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName));
}, InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2,
null, null, SampleContent, SampleContent, bucketName));
}, InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeAsymmetricWrapV2, s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeSymmetricWrapV2, s3EncryptionClientMetadataModeSymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeSymmetricWrapV1N, s3EncryptionClientMetadataModeSymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeAsymmetricWrapV2, s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeSymmetricWrapV2, s3EncryptionClientFileModeSymmetricWrapV1N, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeSymmetricWrapV1N, s3EncryptionClientFileModeSymmetricWrapV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public async void MultipartEncryptionTestMetadataModeKMS()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N, bucketName)
.ConfigureAwait(false);
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N, bucketName));
}, InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2, bucketName));
}, InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingMetadataModeKMS_V2SecurityProfile()
{
metadataConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
filePath, null, null, SampleContent, bucketName)
);
}, LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap_V2SecurityProfile()
{
metadataConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrapV1N, s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
);
}, LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute,"S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap_V2SecurityProfile()
{
fileConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrapV1N, s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName)
);
}, LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestRangeGetIsDisabled()
{
AssertExtensions.ExpectException<NotSupportedException>(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.AttemptRangeGet(s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName));
}, EncryptionTestsUtils.RangeGetNotSupportedMessage);
AssertExtensions.ExpectException<NotSupportedException>(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.AttemptRangeGet(s3EncryptionClientFileModeAsymmetricWrapV2, bucketName));
}, EncryptionTestsUtils.RangeGetNotSupportedMessage);
}
}
}
| 577 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.KeyManagementService.Model;
using Amazon.Runtime.Internal.Util;
using Amazon.S3;
using Amazon.S3.Model;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.NetStandard.Utilities;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV2 : TestBase<AmazonS3Client>
{
private const string InstructionAndKMSErrorMessage =
"AmazonS3EncryptionClientV2 only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private const string sampleContent = "Encryption Client Testing!";
private static readonly byte[] sampleContentBytes = Encoding.UTF8.GetBytes(sampleContent);
private string filePath = EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private string bucketName;
private string kmsKeyID;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeAsymmetricWrap;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeAsymmetricWrap;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeSymmetricWrap;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeSymmetricWrap;
private AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeKMS;
private AmazonS3EncryptionClientV2 s3EncryptionClientFileModeKMS;
private AmazonS3Client s3Client;
public EncryptionTestsV2(KmsKeyIdProvider kmsKeyIdProvider) : base(kmsKeyIdProvider)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsIdAsync().GetAwaiter().GetResult();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterials = new EncryptionMaterialsV2(rsa, AsymmetricAlgorithmType.RsaOaepSha1);
var symmetricEncryptionMaterials = new EncryptionMaterialsV2(aes, SymmetricAlgorithmType.AesGcm);
var kmsEncryptionMaterials =
new EncryptionMaterialsV2(kmsKeyID, KmsType.KmsContext, new Dictionary<string, string>());
var fileConfig = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2)
{
StorageMode = CryptoStorageMode.InstructionFile
};
var metadataConfig = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2)
{
StorageMode = CryptoStorageMode.ObjectMetadata
};
s3EncryptionClientMetadataModeAsymmetricWrap =
new AmazonS3EncryptionClientV2(metadataConfig, asymmetricEncryptionMaterials);
s3EncryptionClientFileModeAsymmetricWrap =
new AmazonS3EncryptionClientV2(fileConfig, asymmetricEncryptionMaterials);
s3EncryptionClientMetadataModeSymmetricWrap =
new AmazonS3EncryptionClientV2(metadataConfig, symmetricEncryptionMaterials);
s3EncryptionClientFileModeSymmetricWrap =
new AmazonS3EncryptionClientV2(fileConfig, symmetricEncryptionMaterials);
s3EncryptionClientMetadataModeKMS = new AmazonS3EncryptionClientV2(metadataConfig, kmsEncryptionMaterials);
s3EncryptionClientFileModeKMS = new AmazonS3EncryptionClientV2(fileConfig, kmsEncryptionMaterials);
s3Client = new AmazonS3Client();
using (var writer = new StreamWriter(File.OpenWrite(filePath)))
{
writer.Write(sampleContent);
writer.Flush();
}
bucketName =
EncryptionTestsUtils.CallAsyncTask(
UtilityMethods.CreateBucketAsync(s3EncryptionClientFileModeAsymmetricWrap));
}
protected override void Dispose(bool disposing)
{
EncryptionTestsUtils.CallAsyncTask(
UtilityMethods.DeleteBucketWithObjectsAsync(s3EncryptionClientMetadataModeAsymmetricWrap, bucketName));
s3EncryptionClientMetadataModeAsymmetricWrap.Dispose();
s3EncryptionClientFileModeAsymmetricWrap.Dispose();
s3EncryptionClientMetadataModeSymmetricWrap.Dispose();
s3EncryptionClientFileModeSymmetricWrap.Dispose();
s3EncryptionClientMetadataModeKMS.Dispose();
s3EncryptionClientFileModeKMS.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetFileUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrap, filePath, null,
null,
sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrap, filePath, null, null,
sampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrap, filePath, null, null,
sampleContent, bucketName)
.ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetStreamUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrap, null,
sampleContentBytes,
null, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetStreamUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrap, null,
sampleContentBytes,
null, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrap, null,
sampleContentBytes,
null, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrap, null,
sampleContentBytes,
null, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrap, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrap, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetTemperedContentUsingMetadataMode()
{
// Put encrypted content
var key = await PutContentAsync(s3EncryptionClientMetadataModeAsymmetricWrap, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
// Temper the content
await TemperCipherTextAsync(s3Client, bucketName, key);
// Verify
AssertExtensions.ExpectException<AmazonCryptoException>(
() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestGetAsync(key, sampleContent,
s3EncryptionClientMetadataModeAsymmetricWrap, bucketName));
}, "Failed to decrypt: mac check in GCM failed");
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetTemperedCekAlgUsingMetadataMode()
{
// Put encrypted content
var key = await PutContentAsync(s3EncryptionClientMetadataModeAsymmetricWrap, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
// Temper the cek algorithm
await TemperCekAlgAsync(s3Client, bucketName, key);
// Verify
AssertExtensions.ExpectException<InvalidDataException>(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestGetAsync(key, sampleContent,
s3EncryptionClientMetadataModeAsymmetricWrap, bucketName));
});
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrap, null, null,
"", "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrap, null, null,
"", "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeAsymmetricWrap, null, null,
null, "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeSymmetricWrap, null, null,
null, "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeAsymmetricWrap, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetContentUsingInstructionFileModeSymmetricWrap()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeSymmetricWrap, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMS,
filePath, null, null, sampleContent, bucketName));
}, InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetStreamUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMS, null, sampleContentBytes,
null, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMS,
null, sampleContentBytes, null, sampleContent, bucketName));
}, InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMS, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetContentWithTemperedEncryptionContextUsingMetadataModeKMS()
{
// Put encrypted content
var key = await PutContentAsync(s3EncryptionClientMetadataModeKMS, null, null,
sampleContent, sampleContent, bucketName).ConfigureAwait(false);
// Temper the cek algorithm
await TemperCekAlgEncryptionContextAsync(s3Client, bucketName, key);
// Verify
AssertExtensions.ExpectException<InvalidCiphertextException>(() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.TestGetAsync(key, sampleContent, s3EncryptionClientMetadataModeKMS,
bucketName));
});
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetZeroLengthContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMS, null, null,
"", "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetNullContentContentUsingMetadataModeKMS()
{
await EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientMetadataModeKMS, null, null,
null, "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task PutGetNullContentContentUsingMetadataModeKMSCalculateMD5()
{
await EncryptionTestsUtils.TestPutGetCalculateMD5Async(s3EncryptionClientMetadataModeKMS, s3EncryptionClientMetadataModeKMS, null, null,
null, "", bucketName).ConfigureAwait(false);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
AsyncHelpers.RunSync(() => EncryptionTestsUtils.TestPutGetAsync(s3EncryptionClientFileModeKMS, null,
null, sampleContent, sampleContent, bucketName));
}, InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task MultipartEncryptionUsingMetadataModeAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeAsymmetricWrap,
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task MultipartEncryptionUsingMetadataModeSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeSymmetricWrap,
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task MultipartEncryptionUsingInstructionFileAsymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeAsymmetricWrap,
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task MultipartEncryptionUsingInstructionFileSymmetricWrap()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeSymmetricWrap,
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task MultipartEncryptionTestMetadataModeKMS()
{
await EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientMetadataModeKMS, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public async Task MultipartEncryptionTestMetadataModeKMSCalculateMD5()
{
await EncryptionTestsUtils.MultipartEncryptionTestCalculateMD5Async(s3EncryptionClientMetadataModeKMS, s3EncryptionClientMetadataModeKMS, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEnecryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(
() =>
{
AsyncHelpers.RunSync(() =>
EncryptionTestsUtils.MultipartEncryptionTestAsync(s3EncryptionClientFileModeKMS, bucketName));
}, InstructionAndKMSErrorMessage);
}
public static async Task<string> PutContentAsync(AmazonS3Client s3EncryptionClient, string filePath,
byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
var key = $"key-{Guid.NewGuid()}";
var request = new PutObjectRequest()
{
BucketName = bucketName,
Key = key,
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
};
var response = await s3EncryptionClient.PutObjectAsync(request).ConfigureAwait(false);
return key;
}
private static async Task TemperCipherTextAsync(AmazonS3Client s3Client, string bucketName, string key)
{
var getObjectRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
using (var getObjectResponse = await s3Client.GetObjectAsync(getObjectRequest).ConfigureAwait(false))
{
var data = getObjectResponse.ResponseStream.ReadAllBytes();
// Flip the stored cipher text first byte and put back
data[0] = (byte)~data[0];
var putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = key,
InputStream = new MemoryStream(data),
};
foreach (var metadataKey in getObjectResponse.Metadata.Keys)
{
putObjectRequest.Metadata.Add(metadataKey, getObjectResponse.Metadata[metadataKey]);
}
await s3Client.PutObjectAsync(putObjectRequest).ConfigureAwait(false);
}
}
private static async Task TemperCekAlgAsync(AmazonS3Client s3Client, string bucketName, string key)
{
var getObjectRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
using (var getObjectResponse = await s3Client.GetObjectAsync(getObjectRequest).ConfigureAwait(false))
{
var data = getObjectResponse.ResponseStream.ReadAllBytes();
var putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = key,
InputStream = new MemoryStream(data),
};
foreach (var metadataKey in getObjectResponse.Metadata.Keys)
{
if (metadataKey.Equals("x-amz-meta-x-amz-cek-alg"))
{
putObjectRequest.Metadata.Add(metadataKey, "Unsupported");
}
else
{
putObjectRequest.Metadata.Add(metadataKey, getObjectResponse.Metadata[metadataKey]);
}
}
await s3Client.PutObjectAsync(putObjectRequest).ConfigureAwait(false);
}
}
private static async Task TemperCekAlgEncryptionContextAsync(AmazonS3Client s3Client, string bucketName,
string key)
{
var getObjectRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
using (var getObjectResponse = await s3Client.GetObjectAsync(getObjectRequest).ConfigureAwait(false))
{
var data = getObjectResponse.ResponseStream.ReadAllBytes();
var putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = key,
InputStream = new MemoryStream(data)
};
foreach (var metadataKey in getObjectResponse.Metadata.Keys)
{
if (metadataKey.Equals("x-amz-meta-x-amz-matdesc"))
{
continue;
}
putObjectRequest.Metadata.Add(metadataKey, getObjectResponse.Metadata[metadataKey]);
}
await s3Client.PutObjectAsync(putObjectRequest).ConfigureAwait(false);
}
}
}
} | 547 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Xunit;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Collections;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public static class AssertExtensions
{
public static void ExpectException(Action action, string message = null)
{
bool gotException = false;
try
{
action();
}
catch (Exception e)
{
gotException = true;
if (!string.IsNullOrEmpty(message))
Assert.Equal(message, e.Message);
}
Assert.True(gotException, "Failed to get expected exception");
}
public static T ExpectException<T>(Action action, string message = null) where T : Exception
{
return ExpectException_Helper<T>(action, message);
}
private static T ExpectException_Helper<T>(Action action, string message = null) where T : Exception
{
var exceptionType = typeof(T);
bool gotException = false;
Exception exception = null;
try
{
action();
}
catch (Exception e)
{
exception = e;
Assert.Equal(e.GetType(), exceptionType);
if (!string.IsNullOrEmpty(message))
Assert.Equal(message, e.Message);
gotException = true;
}
Assert.True(gotException, "Failed to get expected exception: " + exceptionType.FullName);
return (T)exception;
}
}
}
| 73 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Runtime;
using System;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public class DisposableSwitch : IDisposable
{
private bool CallbacksSet { get; set; }
private Action EndAction { get; set; }
public DisposableSwitch(Action onEnd)
: this(null, onEnd) { }
public DisposableSwitch(Action onStart, Action onEnd)
{
SetCallbacks(onStart, onEnd);
}
protected DisposableSwitch()
{ }
protected void SetCallbacks(Action onStart, Action onEnd)
{
if (CallbacksSet)
throw new InvalidOperationException();
if (onStart != null)
onStart();
EndAction = onEnd;
CallbacksSet = true;
}
public void Dispose()
{
if (EndAction != null)
EndAction();
}
}
public class ServiceResponseCounter : DisposableSwitch
{
public int ResponseCount { get; private set; }
private Predicate<AmazonWebServiceRequest> RequestsToCount { get; set; }
private AmazonServiceClient Client { get; set; }
public ServiceResponseCounter(AmazonServiceClient client, Predicate<AmazonWebServiceRequest> requestsToCount = null)
{
ResponseCount = 0;
Client = client;
RequestsToCount = requestsToCount;
SetCallbacks(Attach, Detach);
}
public void Reset()
{
ResponseCount = 0;
}
private void Attach()
{
Client.AfterResponseEvent += Count;
}
private void Detach()
{
Client.AfterResponseEvent -= Count;
}
private void Count(object sender, ResponseEventArgs e)
{
var wsrea = e as WebServiceResponseEventArgs;
var request = wsrea.Request;
if (RequestsToCount == null || RequestsToCount(request))
{
ResponseCount++;
}
}
}
}
| 94 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
internal partial class EncryptionTestsUtils
{
private const long MegaBytesSize = 1048576;
public static async Task MultipartEncryptionTestAsync(AmazonS3Client s3EncryptionClient, string bucketName)
{
await MultipartEncryptionTestAsync(s3EncryptionClient, s3EncryptionClient, bucketName);
}
public static async Task MultipartEncryptionTestAsync(AmazonS3Client s3EncryptionClient,
AmazonS3Client s3DecryptionClient, string bucketName)
{
var filePath = Path.GetTempFileName();
var retrievedFilepath = Path.GetTempFileName();
var totalSize = MegaBytesSize * 15;
UtilityMethods.GenerateFile(filePath, totalSize);
var key = Guid.NewGuid().ToString();
Stream inputStream = File.OpenRead(filePath);
try
{
InitiateMultipartUploadRequest initRequest = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html",
};
InitiateMultipartUploadResponse initResponse =
await s3EncryptionClient.InitiateMultipartUploadAsync(initRequest).ConfigureAwait(false);
// Upload part 1
UploadPartRequest uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 1,
PartSize = 5 * MegaBytesSize,
InputStream = inputStream,
};
UploadPartResponse up1Response =
await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
// Upload part 2
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 2,
PartSize = 5 * MegaBytesSize,
InputStream = inputStream
};
UploadPartResponse up2Response =
await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
// Upload part 3
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 3,
InputStream = inputStream,
IsLastPart = true
};
UploadPartResponse up3Response =
await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
ListPartsRequest listPartRequest = new ListPartsRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
ListPartsResponse listPartResponse =
await s3EncryptionClient.ListPartsAsync(listPartRequest).ConfigureAwait(false);
Assert.Equal(3, listPartResponse.Parts.Count);
Assert.Equal(up1Response.PartNumber, listPartResponse.Parts[0].PartNumber);
Assert.Equal(up1Response.ETag, listPartResponse.Parts[0].ETag);
Assert.Equal(up2Response.PartNumber, listPartResponse.Parts[1].PartNumber);
Assert.Equal(up2Response.ETag, listPartResponse.Parts[1].ETag);
Assert.Equal(up3Response.PartNumber, listPartResponse.Parts[2].PartNumber);
Assert.Equal(up3Response.ETag, listPartResponse.Parts[2].ETag);
listPartRequest.MaxParts = 1;
listPartResponse = await s3EncryptionClient.ListPartsAsync(listPartRequest).ConfigureAwait(false);
Assert.Single(listPartResponse.Parts);
// Complete the response
CompleteMultipartUploadRequest compRequest = new CompleteMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
compRequest.AddPartETags(up1Response, up2Response, up3Response);
CompleteMultipartUploadResponse compResponse =
await s3EncryptionClient.CompleteMultipartUploadAsync(compRequest).ConfigureAwait(false);
Assert.Equal(bucketName, compResponse.BucketName);
Assert.NotNull(compResponse.ETag);
Assert.Equal(key, compResponse.Key);
Assert.NotNull(compResponse.Location);
// Get the file back from S3 and make sure it is still the same.
GetObjectRequest getRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
GetObjectResponse getResponse =
await s3DecryptionClient.GetObjectAsync(getRequest).ConfigureAwait(false);
await getResponse.WriteResponseStreamToFileAsync(retrievedFilepath, false, CancellationToken.None);
UtilityMethods.CompareFiles(filePath, retrievedFilepath);
GetObjectMetadataRequest metaDataRequest = new GetObjectMetadataRequest()
{
BucketName = bucketName,
Key = key
};
GetObjectMetadataResponse metaDataResponse =
await s3DecryptionClient.GetObjectMetadataAsync(metaDataRequest).ConfigureAwait(false);
Assert.Equal("text/html", metaDataResponse.Headers.ContentType);
}
finally
{
inputStream.Dispose();
if (File.Exists(filePath))
File.Delete(filePath);
if (File.Exists(retrievedFilepath))
File.Delete(retrievedFilepath);
}
}
public static async Task MultipartEncryptionTestCalculateMD5Async(AmazonS3Client s3EncryptionClient,
AmazonS3Client s3DecryptionClient, string bucketName)
{
var filePath = Path.GetTempFileName();
var retrievedFilepath = Path.GetTempFileName();
var totalSize = MegaBytesSize * 15;
UtilityMethods.GenerateFile(filePath, totalSize);
var key = Guid.NewGuid().ToString();
Stream inputStream = File.OpenRead(filePath);
try
{
InitiateMultipartUploadRequest initRequest = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html",
};
InitiateMultipartUploadResponse initResponse =
await s3EncryptionClient.InitiateMultipartUploadAsync(initRequest).ConfigureAwait(false);
// Upload part 1
UploadPartRequest uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 1,
PartSize = 5 * MegaBytesSize,
InputStream = inputStream,
CalculateContentMD5Header = true
};
UploadPartResponse up1Response =
await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
// Upload part 2
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 2,
PartSize = 5 * MegaBytesSize,
InputStream = inputStream,
CalculateContentMD5Header = true
};
UploadPartResponse up2Response =
await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
// Upload part 3
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 3,
InputStream = inputStream,
IsLastPart = true,
CalculateContentMD5Header = true
};
UploadPartResponse up3Response =
await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
ListPartsRequest listPartRequest = new ListPartsRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
ListPartsResponse listPartResponse =
await s3EncryptionClient.ListPartsAsync(listPartRequest).ConfigureAwait(false);
Assert.Equal(3, listPartResponse.Parts.Count);
Assert.Equal(up1Response.PartNumber, listPartResponse.Parts[0].PartNumber);
Assert.Equal(up1Response.ETag, listPartResponse.Parts[0].ETag);
Assert.Equal(up2Response.PartNumber, listPartResponse.Parts[1].PartNumber);
Assert.Equal(up2Response.ETag, listPartResponse.Parts[1].ETag);
Assert.Equal(up3Response.PartNumber, listPartResponse.Parts[2].PartNumber);
Assert.Equal(up3Response.ETag, listPartResponse.Parts[2].ETag);
listPartRequest.MaxParts = 1;
listPartResponse = await s3EncryptionClient.ListPartsAsync(listPartRequest).ConfigureAwait(false);
Assert.Single(listPartResponse.Parts);
// Complete the response
CompleteMultipartUploadRequest compRequest = new CompleteMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
compRequest.AddPartETags(up1Response, up2Response, up3Response);
CompleteMultipartUploadResponse compResponse =
await s3EncryptionClient.CompleteMultipartUploadAsync(compRequest).ConfigureAwait(false);
Assert.Equal(bucketName, compResponse.BucketName);
Assert.NotNull(compResponse.ETag);
Assert.Equal(key, compResponse.Key);
Assert.NotNull(compResponse.Location);
// Get the file back from S3 and make sure it is still the same.
GetObjectRequest getRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
GetObjectResponse getResponse =
await s3DecryptionClient.GetObjectAsync(getRequest).ConfigureAwait(false);
await getResponse.WriteResponseStreamToFileAsync(retrievedFilepath, false, CancellationToken.None);
UtilityMethods.CompareFiles(filePath, retrievedFilepath);
GetObjectMetadataRequest metaDataRequest = new GetObjectMetadataRequest()
{
BucketName = bucketName,
Key = key
};
GetObjectMetadataResponse metaDataResponse =
await s3DecryptionClient.GetObjectMetadataAsync(metaDataRequest).ConfigureAwait(false);
Assert.Equal("text/html", metaDataResponse.Headers.ContentType);
}
finally
{
inputStream.Dispose();
if (File.Exists(filePath))
File.Delete(filePath);
if (File.Exists(retrievedFilepath))
File.Delete(retrievedFilepath);
}
}
public static async Task TestPutGetAsync(AmazonS3Client s3EncryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
await TestPutGetAsync(s3EncryptionClient, s3EncryptionClient, filePath, inputStreamBytes, contentBody,
expectedContent, bucketName);
}
public static async Task TestPutGetAsync(AmazonS3Client s3EncryptionClient, AmazonS3Client s3DecryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
PutObjectRequest request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
};
PutObjectResponse response = await s3EncryptionClient.PutObjectAsync(request).ConfigureAwait(false);
await TestGetAsync(request.Key, expectedContent, s3DecryptionClient, bucketName).ConfigureAwait(false);
}
public static async Task TestPutGetCalculateMD5Async(AmazonS3Client s3EncryptionClient, AmazonS3Client s3DecryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
PutObjectRequest request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
CalculateContentMD5Header = true
};
PutObjectResponse response = await s3EncryptionClient.PutObjectAsync(request).ConfigureAwait(false);
await TestGetAsync(request.Key, expectedContent, s3DecryptionClient, bucketName).ConfigureAwait(false);
}
public static async Task TestGetAsync(string key, string uploadedData, AmazonS3Client s3EncryptionClient,
string bucketName)
{
GetObjectRequest getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = key
};
using (GetObjectResponse getObjectResponse =
await s3EncryptionClient.GetObjectAsync(getObjectRequest).ConfigureAwait(false))
{
using (var stream = getObjectResponse.ResponseStream)
using (var reader = new StreamReader(stream))
{
string data = reader.ReadToEnd();
Assert.Equal(uploadedData, data);
}
}
}
public static async Task AttemptRangeGet(IAmazonS3 s3EncryptionClient, string bucketName)
{
var getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = "foo",
ByteRange = new ByteRange(2, 4)
};
await s3EncryptionClient.GetObjectAsync(getObjectRequest).ConfigureAwait(false);
}
public static void CallAsyncTask(Task asyncTask)
{
asyncTask.GetAwaiter().GetResult();
}
public static T CallAsyncTask<T>(Task<T> asyncTask)
{
return asyncTask.GetAwaiter().GetResult();
}
}
} | 389 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Amazon.KeyManagementService;
using Amazon.KeyManagementService.Model;
using Amazon.ResourceGroupsTaggingAPI;
using Amazon.ResourceGroupsTaggingAPI.Model;
using Tag = Amazon.KeyManagementService.Model.Tag;
namespace AWSSDK.Extensions.S3.Encryption.IntegrationTests.NetStandard.Utilities
{
public class KmsKeyIdProvider
{
private string _kmsId;
private const string KmsIdTagKey = "Amazon-Extensions-S3-Encryption-Integration-Test";
public async Task<string> GetKmsIdAsync()
{
if (!string.IsNullOrEmpty(_kmsId))
{
return _kmsId;
}
using (var taggingClient = new AmazonResourceGroupsTaggingAPIClient())
{
var getResourcesRequest = new GetResourcesRequest
{
TagFilters = new List<TagFilter>
{
new TagFilter()
{
Key = KmsIdTagKey
}
}
};
var resourcesResponse = await taggingClient.GetResourcesAsync(getResourcesRequest);
if (resourcesResponse.ResourceTagMappingList.Count > 0)
{
var first = resourcesResponse.ResourceTagMappingList.First();
_kmsId = first.ResourceARN.Split('/').Last();
return _kmsId;
}
}
using (var kmsClient = new AmazonKeyManagementServiceClient())
{
var createKeyRequest = new CreateKeyRequest
{
Description = "Key for .NET integration tests.",
Origin = OriginType.AWS_KMS,
KeyUsage = KeyUsageType.ENCRYPT_DECRYPT,
Tags = new List<Tag>
{
new Tag()
{
TagKey = KmsIdTagKey,
TagValue = string.Empty
}
}
};
var response = await kmsClient.CreateKeyAsync(createKeyRequest);
_kmsId = response.KeyMetadata.KeyId;
return _kmsId;
}
}
}
} | 86 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public static class StreamUtils
{
/// <summary>
/// Reads the contents of the stream into a byte array.
/// data is returned as a byte array. An IOException is
/// thrown if any of the underlying IO calls fail.
/// </summary>
/// <param name="stream">The stream to read.</param>
/// <returns>A byte array containing the contents of the stream.</returns>
/// <exception cref="NotSupportedException">The stream does not support reading.</exception>
/// <exception cref="ObjectDisposedException">Methods were called after the stream was closed.</exception>
/// <exception cref="System.IO.IOException">An I/O error occurs.</exception>
public static byte[] ReadAllBytes(this Stream stream)
{
byte[] readBuffer = new byte[4096];
int totalBytesRead = 0;
int bytesRead;
while ((bytesRead = stream.Read(readBuffer, totalBytesRead, readBuffer.Length - totalBytesRead)) > 0)
{
totalBytesRead += bytesRead;
if (totalBytesRead == readBuffer.Length)
{
int nextByte = stream.ReadByte();
if (nextByte != -1)
{
byte[] temp = new byte[readBuffer.Length * 2];
Buffer.BlockCopy(readBuffer, 0, temp, 0, readBuffer.Length);
Buffer.SetByte(temp, totalBytesRead, (byte)nextByte);
readBuffer = temp;
totalBytesRead++;
}
}
}
byte[] buffer = readBuffer;
if (readBuffer.Length != totalBytesRead)
{
buffer = new byte[totalBytesRead];
Buffer.BlockCopy(readBuffer, 0, buffer, 0, totalBytesRead);
}
return buffer;
}
}
} | 64 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
using System.Threading.Tasks;
using Amazon.Runtime;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.NetStandard.Utilities;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public abstract class TestBase
{
public const string CategoryAttribute = "Category";
static TestBase()
{
AWSConfigs.RegionEndpoint = RegionEndpoint.USWest2;
}
public TestBase()
{
}
public static TClient CreateClient<TClient>(AWSCredentials credentials = null,
RegionEndpoint endpoint = null) where TClient : AmazonServiceClient
{
endpoint = endpoint ?? AWSConfigs.RegionEndpoint;
if (credentials != null)
{
return (TClient)Activator.CreateInstance(typeof(TClient),
new object[] { credentials, endpoint });
}
else
{
return (TClient)Activator.CreateInstance(typeof(TClient),
new object[] { endpoint });
}
}
}
public abstract class TestBase<T> : TestBase, IDisposable, IClassFixture<KmsKeyIdProvider> where T : AmazonServiceClient, IDisposable
{
protected readonly KmsKeyIdProvider _kmsKeyIdProvider;
private bool _disposed = false;
private T _client = null;
public T Client
{
get
{
if (_client == null)
{
_client = CreateClient<T>(endpoint: ActualEndpoint);
}
return _client;
}
}
public static string BaseDirectoryPath { get; set; }
protected virtual RegionEndpoint AlternateEndpoint
{
get
{
return null;
}
}
protected RegionEndpoint ActualEndpoint
{
get
{
return (AlternateEndpoint ?? AWSConfigs.RegionEndpoint);
}
}
static TestBase()
{
BaseDirectoryPath = Directory.GetCurrentDirectory();
}
public TestBase(KmsKeyIdProvider kmsKeyIdProvider)
{
_kmsKeyIdProvider = kmsKeyIdProvider;
}
protected static void RunAsSync(Func<Task> asyncFunc)
{
UtilityMethods.RunAsSync(asyncFunc);
}
#region IDispose implementation
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (_disposed)
return;
if (disposing)
{
this.Client.Dispose();
_disposed = true;
}
}
#endregion
}
}
| 133 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.IO;
using System.Net;
using System.Security.Cryptography;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Amazon.Runtime.Internal;
using Amazon.S3;
using Amazon.S3.Model;
using Amazon.S3.Util;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
internal class UtilityMethods
{
public const string SDK_TEST_PREFIX = "aws-net-sdk";
public async static Task<string> CreateBucketAsync(IAmazonS3 s3Client)
{
string bucketName = $"{SDK_TEST_PREFIX}-{Guid.NewGuid()}";
await s3Client.PutBucketAsync(new PutBucketRequest {BucketName = bucketName});
while (!await AmazonS3Util.DoesS3BucketExistV2Async(s3Client, bucketName))
{
await Task.Delay(500);
}
return bucketName;
}
public static void WriteFile(string path, string contents)
{
string fullPath = Path.GetFullPath(path);
new DirectoryInfo(Path.GetDirectoryName(fullPath)).Create();
File.WriteAllText(fullPath, contents);
}
public static void GenerateFile(string path, long size)
{
string contents = GenerateTestContents(size);
WriteFile(path, contents);
}
public static string GenerateTestContents(long size)
{
StringBuilder sb = new StringBuilder();
for (long i = 0; i < size; i++)
{
char c = (char)('a' + (i % 26));
sb.Append(c);
}
string contents = sb.ToString();
return contents;
}
public static Task DeleteBucketWithObjectsAsync(IAmazonS3 s3Client, string bucketName)
{
return DeleteS3BucketWithObjectsAsync(s3Client, bucketName);
}
private async static Task DeleteS3BucketWithObjectsAsync(IAmazonS3 s3Client, string bucketName,
CancellationToken cancellationToken = new CancellationToken())
{
// Validations.
if (s3Client == null)
{
throw new ArgumentNullException("s3Client", "The s3Client cannot be null!");
}
if (string.IsNullOrEmpty(bucketName))
{
throw new ArgumentNullException("bucketName", "The bucketName cannot be null or empty string!");
}
var listVersionsRequest = new ListVersionsRequest
{
BucketName = bucketName
};
ListVersionsResponse listVersionsResponse;
string lastRequestId = null;
// Iterate through the objects in the bucket and delete them.
do
{
// Check if the operation has been canceled.
cancellationToken.ThrowIfCancellationRequested();
// List all the versions of all the objects in the bucket.
listVersionsResponse = await s3Client.ListVersionsAsync(listVersionsRequest).ConfigureAwait(false);
// Silverlight uses HTTP caching, so avoid an infinite loop by throwing an exception
if (string.Equals(lastRequestId, listVersionsResponse.ResponseMetadata.RequestId, StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException();
}
lastRequestId = listVersionsResponse.ResponseMetadata.RequestId;
if (listVersionsResponse.Versions.Count == 0)
{
// If the bucket has no objects break the loop.
break;
}
var keyVersionList = new List<KeyVersion>(listVersionsResponse.Versions.Count);
for (int index = 0; index < listVersionsResponse.Versions.Count; index++)
{
keyVersionList.Add(new KeyVersion
{
Key = listVersionsResponse.Versions[index].Key,
VersionId = listVersionsResponse.Versions[index].VersionId
});
}
try
{
// Delete the current set of objects.
var deleteObjectsResponse = await s3Client.DeleteObjectsAsync(new DeleteObjectsRequest
{
BucketName = bucketName,
Objects = keyVersionList,
Quiet = true
}).ConfigureAwait(false);
//if (!deleteOptions.QuietMode)
//{
// // If quiet mode is not set, update the client with list of deleted objects.
// InvokeS3DeleteBucketWithObjectsUpdateCallback(
// updateCallback,
// new S3DeleteBucketWithObjectsUpdate
// {
// DeletedObjects = deleteObjectsResponse.DeletedObjects
// }
// );
//}
}
catch //(DeleteObjectsException deleteObjectsException)
{
//if (deleteOptions.ContinueOnError)
//{
// // Continue the delete operation if an error was encountered.
// // Update the client with the list of objects that were deleted and the
// // list of objects on which the delete failed.
// InvokeS3DeleteBucketWithObjectsUpdateCallback(
// updateCallback,
// new S3DeleteBucketWithObjectsUpdate
// {
// DeletedObjects = deleteObjectsException.Response.DeletedObjects,
// DeleteErrors = deleteObjectsException.Response.DeleteErrors
// }
// );
//}
//else
//{
// // Re-throw the exception if an error was encountered.
// throw;
//}
throw;
}
// Set the markers to get next set of objects from the bucket.
listVersionsRequest.KeyMarker = listVersionsResponse.NextKeyMarker;
listVersionsRequest.VersionIdMarker = listVersionsResponse.NextVersionIdMarker;
}
// Continue listing objects and deleting them until the bucket is empty.
while (listVersionsResponse.IsTruncated);
const int maxRetries = 10;
for (int retries = 1; retries <= maxRetries; retries++)
{
try
{
// Bucket is empty, delete the bucket.
await s3Client.DeleteBucketAsync(new DeleteBucketRequest
{
BucketName = bucketName
}).ConfigureAwait(false);
break;
}
catch (AmazonS3Exception e)
{
if (e.StatusCode != HttpStatusCode.Conflict || retries == maxRetries)
throw;
else
DefaultRetryPolicy.WaitBeforeRetry(retries, 5000);
}
}
//// Signal that the operation is completed.
//asyncCancelableResult.SignalWaitHandleOnCompleted();
}
public static void RunAsSync(Func<Task> asyncFunc)
{
Task.Run(asyncFunc).Wait();
}
private static byte[] computeHash(string file)
{
byte[] fileMD5;
using (Stream fileStream = File.OpenRead(file))
{
fileMD5 = MD5.Create().ComputeHash(fileStream);
}
return fileMD5;
}
public static void CompareFiles(string file1, string file2)
{
byte[] file1MD5 = computeHash(file1);
byte[] file2MD5 = computeHash(file2);
Assert.Equal(file1MD5.Length, file2MD5.Length);
for (int i = 0; i < file1MD5.Length; i++)
{
Assert.Equal(file1MD5[i], file2MD5[i]);
}
}
}
}
| 241 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
internal partial class EncryptionTestsUtils
{
public const string EncryptionPutObjectFilePrefix = "EncryptionPutObjectFile";
public const string RangeGetNotSupportedMessage =
"Unable to perform range get request: Range get is not supported. " +
"See https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html";
public static string GetRandomFilePath(string prefix)
{
return Path.Combine(Path.GetTempPath(), $"{prefix}-{Guid.NewGuid()}.txt");
}
}
} | 34 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Runtime;
using Amazon.S3;
using Amazon.S3.Util;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Xunit;
#if AWS_APM_API
using System.Text.RegularExpressions;
using Amazon.S3.Model;
#endif
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV1InteropV1N : TestBase<AmazonS3Client>
{
private const string InstructionAndKMSErrorMessage =
"AmazonS3EncryptionClient only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private const string SampleContent = "Encryption Client Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath =
EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private static string bucketName;
private static string kmsKeyID;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1;
#pragma warning disable 0618
private static AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1N;
private static AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1N;
#pragma warning restore 0618
public EncryptionTestsV1InteropV1N() : base(KmsKeyIdProvider.Instance)
{
filePath = Path.Combine(Path.GetTempPath(), $"EncryptionPutObjectFile-{Guid.NewGuid()}.txt");
kmsKeyID = _kmsKeyIdProvider.GetKmsId();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(rsa);
var asymmetricEncryptionMaterialsV1N = new EncryptionMaterials(rsa);
var symmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(aes);
var symmetricEncryptionMaterialsV1N = new EncryptionMaterials(aes);
var kmsEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(kmsKeyID);
var kmsEncryptionMaterialsV1N = new EncryptionMaterials(kmsKeyID);
var configV1 = new Amazon.S3.Encryption.AmazonS3CryptoConfiguration()
{
StorageMode = Amazon.S3.Encryption.CryptoStorageMode.InstructionFile
};
var configV1N = new AmazonS3CryptoConfiguration()
{
StorageMode = CryptoStorageMode.InstructionFile
};
s3EncryptionClientMetadataModeAsymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeAsymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, asymmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeSymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeSymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, symmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeKMSV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(kmsEncryptionMaterialsV1);
s3EncryptionClientFileModeKMSV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, kmsEncryptionMaterialsV1);
s3EncryptionClientMetadataModeAsymmetricWrapV1N =
new AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeAsymmetricWrapV1N =
new AmazonS3EncryptionClient(configV1N, asymmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeSymmetricWrapV1N =
new AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeSymmetricWrapV1N =
new AmazonS3EncryptionClient(configV1N, symmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeKMSV1N = new AmazonS3EncryptionClient(kmsEncryptionMaterialsV1N);
s3EncryptionClientFileModeKMSV1N = new AmazonS3EncryptionClient(configV1N, kmsEncryptionMaterialsV1N);
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = S3TestUtils.CreateBucketWithWait(s3EncryptionClientFileModeAsymmetricWrapV1);
}
protected override void Dispose(bool disposing)
{
AmazonS3Util.DeleteS3BucketWithObjects(s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName);
s3EncryptionClientMetadataModeAsymmetricWrapV1.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeKMSV1.Dispose();
s3EncryptionClientFileModeKMSV1.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeKMSV1N.Dispose();
s3EncryptionClientFileModeKMSV1N.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV1, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV1, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeKMSV1N,
s3EncryptionClientFileModeKMSV1, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeKMSV1,
s3EncryptionClientFileModeKMSV1N, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeKMS()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeKMSV1N,
s3EncryptionClientMetadataModeKMSV1, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeKMSV1,
s3EncryptionClientMetadataModeKMSV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV1,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV1,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV1,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, null, "", "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1,
null, null, "", "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1,
null, null, null, "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1,
null, null, null, "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV1,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1,
null, SampleContentBytes, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, null, "", "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null,
null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV1,
null, null, null, "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV1N,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV1,
null, null, SampleContent, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV1, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV1, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV1, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeKMS()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeKMSV1N,
s3EncryptionClientMetadataModeKMSV1, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeKMSV1,
s3EncryptionClientMetadataModeKMSV1N, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeKMSV1N,
s3EncryptionClientFileModeKMSV1, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeKMSV1,
s3EncryptionClientFileModeKMSV1N, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
#if AWS_APM_API
private static readonly Regex APMKMSErrorRegex = new Regex("Please use the synchronous version instead.");
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestGetObjectAPMKMS()
{
PutObjectRequest putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
s3EncryptionClientMetadataModeKMSV1.PutObject(putObjectRequest);
GetObjectRequest getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = putObjectRequest.Key
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1.EndGetObject(
s3EncryptionClientMetadataModeKMSV1.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1N.EndGetObject(
s3EncryptionClientMetadataModeKMSV1N.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestPutObjectAPMKMS()
{
// Request object is modified internally, therefore, it is required to have separate requests for every test
PutObjectRequest requestV1 = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMSV1.EndPutObject(
s3EncryptionClientMetadataModeKMSV1.BeginPutObject(requestV1, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
PutObjectRequest requestV2 = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMSV1N.EndPutObject(
s3EncryptionClientMetadataModeKMSV1N.BeginPutObject(requestV2, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestInitiateMultipartUploadAPMKMS()
{
InitiateMultipartUploadRequest request = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html",
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMSV1.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1N.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMSV1N.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
#endif
}
} | 704 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using System.Text.RegularExpressions;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.Runtime;
using Amazon.S3;
using Amazon.S3.Util;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Xunit;
#if AWS_APM_API
using System;
using Amazon.S3.Model;
#endif
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV1InteropV2 : TestBase<AmazonS3Client>
{
private const string InstructionAndKMSErrorMessage =
"AmazonS3EncryptionClient only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private static readonly string LegacyReadWhenLegacyDisabledMessage =
$"The requested object is encrypted with V1 encryption schemas that have been disabled by client configuration {nameof(SecurityProfile.V2)}." +
$" Retry with {nameof(SecurityProfile.V2AndLegacy)} enabled or reencrypt the object.";
private static readonly Regex APMKMSErrorRegex = new Regex("Please use the synchronous version instead.");
private AmazonS3CryptoConfigurationV2 metadataConfig;
private const string SampleContent = "Encryption Client Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath =
EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private static string bucketName;
private static string kmsKeyID;
private AmazonS3CryptoConfigurationV2 fileConfig;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1;
private static Amazon.S3.Encryption.AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeAsymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeAsymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeSymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeSymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeKMSV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeKMSV2;
public EncryptionTestsV1InteropV2() : base(KmsKeyIdProvider.Instance)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsId();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(rsa);
var asymmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(rsa, AsymmetricAlgorithmType.RsaOaepSha1);
var symmetricEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(aes);
var symmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(aes, SymmetricAlgorithmType.AesGcm);
var kmsEncryptionMaterialsV1 = new Amazon.S3.Encryption.EncryptionMaterials(kmsKeyID);
var kmsEncryptionMaterialsV2 =
new EncryptionMaterialsV2(kmsKeyID, KmsType.KmsContext, new Dictionary<string, string>());
var configV1 = new Amazon.S3.Encryption.AmazonS3CryptoConfiguration
{
StorageMode = Amazon.S3.Encryption.CryptoStorageMode.InstructionFile
};
fileConfig = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.InstructionFile
};
metadataConfig = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.ObjectMetadata
};
s3EncryptionClientMetadataModeAsymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeAsymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, asymmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeSymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1);
s3EncryptionClientFileModeSymmetricWrapV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, symmetricEncryptionMaterialsV1);
s3EncryptionClientMetadataModeKMSV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(kmsEncryptionMaterialsV1);
s3EncryptionClientFileModeKMSV1 =
new Amazon.S3.Encryption.AmazonS3EncryptionClient(configV1, kmsEncryptionMaterialsV1);
s3EncryptionClientMetadataModeAsymmetricWrapV2 =
new AmazonS3EncryptionClientV2(metadataConfig, asymmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeAsymmetricWrapV2 =
new AmazonS3EncryptionClientV2(fileConfig, asymmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeSymmetricWrapV2 =
new AmazonS3EncryptionClientV2(metadataConfig, symmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeSymmetricWrapV2 =
new AmazonS3EncryptionClientV2(fileConfig, symmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeKMSV2 =
new AmazonS3EncryptionClientV2(metadataConfig, kmsEncryptionMaterialsV2);
s3EncryptionClientFileModeKMSV2 = new AmazonS3EncryptionClientV2(fileConfig, kmsEncryptionMaterialsV2);
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = S3TestUtils.CreateBucketWithWait(s3EncryptionClientFileModeAsymmetricWrapV1);
}
protected override void Dispose(bool disposing)
{
AmazonS3Util.DeleteS3BucketWithObjects(s3EncryptionClientMetadataModeAsymmetricWrapV1, bucketName);
s3EncryptionClientMetadataModeAsymmetricWrapV1.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1.Dispose();
s3EncryptionClientMetadataModeKMSV1.Dispose();
s3EncryptionClientFileModeKMSV1.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrapV2.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV2.Dispose();
s3EncryptionClientFileModeSymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeKMSV2.Dispose();
s3EncryptionClientFileModeKMSV2.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeKMSV1,
s3EncryptionClientFileModeKMSV2, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeKMS()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeKMSV1,
s3EncryptionClientMetadataModeKMSV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null,
null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1, s3EncryptionClientMetadataModeKMSV2,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1, s3EncryptionClientFileModeKMSV2,
null, null, SampleContent, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeSymmetricWrapV1,
s3EncryptionClientMetadataModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeSymmetricWrapV1,
s3EncryptionClientFileModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeKMS()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeKMSV1,
s3EncryptionClientMetadataModeKMSV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeKMSV1,
s3EncryptionClientFileModeKMSV2, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeKMS_V2SecurityProfile()
{
metadataConfig.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1,
s3EncryptionClientMetadataModeKMSV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonCryptoException), LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap_V2SecurityProfile()
{
metadataConfig.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonCryptoException), LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap_V2SecurityProfile()
{
fileConfig.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1,
s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonCryptoException), LegacyReadWhenLegacyDisabledMessage);
}
#if AWS_APM_API
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestGetObjectAPMKMS()
{
PutObjectRequest putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
s3EncryptionClientMetadataModeKMSV1.PutObject(putObjectRequest);
GetObjectRequest getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = putObjectRequest.Key
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1.EndGetObject(
s3EncryptionClientMetadataModeKMSV1.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV2.EndGetObject(
s3EncryptionClientMetadataModeKMSV2.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestPutObjectAPMKMS()
{
// Request object is modified internally, therefore, it is required to have separate requests for every test
PutObjectRequest requestV1 = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMSV1.EndPutObject(
s3EncryptionClientMetadataModeKMSV1.BeginPutObject(requestV1, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
PutObjectRequest requestV2 = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMSV2.EndPutObject(
s3EncryptionClientMetadataModeKMSV2.BeginPutObject(requestV2, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestInitiateMultipartUploadAPMKMS()
{
InitiateMultipartUploadRequest request = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html",
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMSV1.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV2.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMSV2.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
#endif
}
} | 619 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.Runtime;
using Amazon.S3;
using Amazon.S3.Util;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Xunit;
#if AWS_APM_API
using System;
using System.Text.RegularExpressions;
using Amazon.S3.Model;
#endif
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV1NInteropV2 : TestBase<AmazonS3Client>
{
private const string InstructionAndKMSErrorMessageV1N =
"AmazonS3EncryptionClient only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private const string InstructionAndKMSErrorMessageV2 =
"AmazonS3EncryptionClientV2 only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private static readonly string LegacyReadWhenLegacyDisabledMessage =
$"The requested object is encrypted with V1 encryption schemas that have been disabled by client configuration {nameof(SecurityProfile.V2)}." +
$" Retry with {nameof(SecurityProfile.V2AndLegacy)} enabled or reencrypt the object.";
private const string SampleContent = "Encryption Client Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath =
EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private static string bucketName;
private static string kmsKeyID;
private readonly AmazonS3CryptoConfigurationV2 metadataConfigV2;
private readonly AmazonS3CryptoConfigurationV2 fileConfigV2;
#pragma warning disable 0618
private static AmazonS3EncryptionClient s3EncryptionClientMetadataModeAsymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientFileModeAsymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientMetadataModeSymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientFileModeSymmetricWrapV1N;
private static AmazonS3EncryptionClient s3EncryptionClientMetadataModeKMSV1N;
private static AmazonS3EncryptionClient s3EncryptionClientFileModeKMSV1N;
#pragma warning restore 0618
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeAsymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeAsymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeSymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeSymmetricWrapV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeKMSV2;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeKMSV2;
public EncryptionTestsV1NInteropV2() : base(KmsKeyIdProvider.Instance)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsId();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterialsV1N = new EncryptionMaterials(rsa);
var symmetricEncryptionMaterialsV1N = new EncryptionMaterials(aes);
var kmsEncryptionMaterialsV1N = new EncryptionMaterials(kmsKeyID);
var configV1N = new AmazonS3CryptoConfiguration()
{
StorageMode = CryptoStorageMode.InstructionFile
};
var asymmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(rsa, AsymmetricAlgorithmType.RsaOaepSha1);
var symmetricEncryptionMaterialsV2 = new EncryptionMaterialsV2(aes, SymmetricAlgorithmType.AesGcm);
var kmsEncryptionMaterialsV2 =
new EncryptionMaterialsV2(kmsKeyID, KmsType.KmsContext, new Dictionary<string, string>());
fileConfigV2 = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.InstructionFile,
};
metadataConfigV2 = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2AndLegacy)
{
StorageMode = CryptoStorageMode.ObjectMetadata,
};
s3EncryptionClientMetadataModeAsymmetricWrapV1N =
new AmazonS3EncryptionClient(asymmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeAsymmetricWrapV1N =
new AmazonS3EncryptionClient(configV1N, asymmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeSymmetricWrapV1N =
new AmazonS3EncryptionClient(symmetricEncryptionMaterialsV1N);
s3EncryptionClientFileModeSymmetricWrapV1N =
new AmazonS3EncryptionClient(configV1N, symmetricEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeKMSV1N = new AmazonS3EncryptionClient(kmsEncryptionMaterialsV1N);
s3EncryptionClientFileModeKMSV1N = new AmazonS3EncryptionClient(configV1N, kmsEncryptionMaterialsV1N);
s3EncryptionClientMetadataModeAsymmetricWrapV2 =
new AmazonS3EncryptionClientV2(metadataConfigV2, asymmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeAsymmetricWrapV2 =
new AmazonS3EncryptionClientV2(fileConfigV2, asymmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeSymmetricWrapV2 =
new AmazonS3EncryptionClientV2(metadataConfigV2, symmetricEncryptionMaterialsV2);
s3EncryptionClientFileModeSymmetricWrapV2 =
new AmazonS3EncryptionClientV2(fileConfigV2, symmetricEncryptionMaterialsV2);
s3EncryptionClientMetadataModeKMSV2 =
new AmazonS3EncryptionClientV2(metadataConfigV2, kmsEncryptionMaterialsV2);
s3EncryptionClientFileModeKMSV2 = new AmazonS3EncryptionClientV2(fileConfigV2, kmsEncryptionMaterialsV2);
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = S3TestUtils.CreateBucketWithWait(s3EncryptionClientFileModeAsymmetricWrapV1N);
}
protected override void Dispose(bool disposing)
{
AmazonS3Util.DeleteS3BucketWithObjects(s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName);
s3EncryptionClientMetadataModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV1N.Dispose();
s3EncryptionClientFileModeSymmetricWrapV1N.Dispose();
s3EncryptionClientMetadataModeKMSV1N.Dispose();
s3EncryptionClientFileModeKMSV1N.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrapV2.Dispose();
s3EncryptionClientFileModeAsymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeSymmetricWrapV2.Dispose();
s3EncryptionClientFileModeSymmetricWrapV2.Dispose();
s3EncryptionClientMetadataModeKMSV2.Dispose();
s3EncryptionClientFileModeKMSV2.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeAsymmetricWrapV2,
s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeSymmetricWrapV2,
s3EncryptionClientFileModeSymmetricWrapV1N, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeKMSV2,
s3EncryptionClientFileModeKMSV1N, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeKMSV1N,
s3EncryptionClientFileModeKMSV2, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeKMS()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeKMSV2,
s3EncryptionClientMetadataModeKMSV1N, bucketName);
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeKMSV1N,
s3EncryptionClientMetadataModeKMSV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV2,
s3EncryptionClientFileModeAsymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV2,
s3EncryptionClientFileModeSymmetricWrapV1N,
filePath, null, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV2,
s3EncryptionClientFileModeAsymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV2,
s3EncryptionClientFileModeSymmetricWrapV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, "", "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, "", "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N,
null, null, null, "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N,
null, null, null, "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV2,
s3EncryptionClientFileModeAsymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV2,
s3EncryptionClientFileModeSymmetricWrapV1N,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N,
null, SampleContentBytes, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2,
null, SampleContentBytes, null, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, null, SampleContent, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, null, "", "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null,
null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV2, s3EncryptionClientMetadataModeKMSV1N,
null, null, null, "", bucketName);
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N, s3EncryptionClientMetadataModeKMSV2,
null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV2, s3EncryptionClientFileModeKMSV1N,
null, null, SampleContent, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMSV1N, s3EncryptionClientFileModeKMSV2,
null, null, SampleContent, SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeAsymmetricWrapV2,
s3EncryptionClientMetadataModeAsymmetricWrapV1N, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeSymmetricWrapV2,
s3EncryptionClientMetadataModeSymmetricWrapV1N, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeSymmetricWrapV1N,
s3EncryptionClientMetadataModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeAsymmetricWrapV2,
s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeSymmetricWrapV2,
s3EncryptionClientFileModeSymmetricWrapV1N, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeSymmetricWrapV1N,
s3EncryptionClientFileModeSymmetricWrapV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeKMS()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeKMSV2,
s3EncryptionClientMetadataModeKMSV1N, bucketName);
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeKMSV1N,
s3EncryptionClientMetadataModeKMSV2, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeKMSV2,
s3EncryptionClientFileModeKMSV1N, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV2);
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeKMSV1N,
s3EncryptionClientFileModeKMSV2, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessageV1N);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeKMS_V2SecurityProfile()
{
metadataConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMSV1N,
s3EncryptionClientMetadataModeKMSV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonCryptoException), LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap_V2SecurityProfile()
{
metadataConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrapV1N,
s3EncryptionClientMetadataModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonCryptoException), LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap_V2SecurityProfile()
{
fileConfigV2.SecurityProfile = SecurityProfile.V2;
AssertExtensions.ExpectException(() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrapV1N,
s3EncryptionClientFileModeAsymmetricWrapV2,
filePath, null, null, SampleContent, bucketName);
}, typeof(AmazonCryptoException), LegacyReadWhenLegacyDisabledMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestRangeGetIsDisabled()
{
EncryptionTestsUtils.TestRangeGetDisabled(s3EncryptionClientFileModeAsymmetricWrapV1N, bucketName);
EncryptionTestsUtils.TestRangeGetDisabled(s3EncryptionClientFileModeAsymmetricWrapV2, bucketName);
}
#if AWS_APM_API
private static readonly Regex APMKMSErrorRegex = new Regex("Please use the synchronous version instead.");
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestGetObjectAPMKMS()
{
PutObjectRequest putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent
};
s3EncryptionClientMetadataModeKMSV1N.PutObject(putObjectRequest);
GetObjectRequest getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = putObjectRequest.Key
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1N.EndGetObject(
s3EncryptionClientMetadataModeKMSV1N.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV2.EndGetObject(
s3EncryptionClientMetadataModeKMSV2.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestPutObjectAPMKMS()
{
// Request object is modified internally, therefore, it is required to have separate requests for every test
PutObjectRequest requestV1 = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMSV1N.EndPutObject(
s3EncryptionClientMetadataModeKMSV1N.BeginPutObject(requestV1, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
PutObjectRequest requestV2 = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMSV2.EndPutObject(
s3EncryptionClientMetadataModeKMSV2.BeginPutObject(requestV2, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestInitiateMultipartUploadAPMKMS()
{
InitiateMultipartUploadRequest request = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html"
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV1N.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMSV1N.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMSV2.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMSV2.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
#endif
}
} | 767 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.Collections.Generic;
using System.IO;
using System.Security.Cryptography;
using System.Text;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.Extensions.S3.Encryption.Primitives;
using Amazon.Runtime;
using Amazon.S3;
using Amazon.S3.Util;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Xunit;
#if AWS_APM_API
using System;
using System.Text.RegularExpressions;
using Amazon.S3.Model;
#endif
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public class EncryptionTestsV2 : TestBase<AmazonS3Client>
{
private const string InstructionAndKMSErrorMessage =
"AmazonS3EncryptionClientV2 only supports KMS key wrapping in metadata storage mode. " +
"Please set StorageMode to CryptoStorageMode.ObjectMetadata or refrain from using KMS EncryptionMaterials.";
private const string SampleContent = "Encryption Client V2 Testing!";
private static readonly byte[] SampleContentBytes = Encoding.UTF8.GetBytes(SampleContent);
private string filePath =
EncryptionTestsUtils.GetRandomFilePath(EncryptionTestsUtils.EncryptionPutObjectFilePrefix);
private static string bucketName;
private static string kmsKeyID;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeSymmetricWrap;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeSymmetricWrap;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeAsymmetricWrap;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeAsymmetricWrap;
private static AmazonS3EncryptionClientV2 s3EncryptionClientMetadataModeKMS;
private static AmazonS3EncryptionClientV2 s3EncryptionClientFileModeKMS;
public EncryptionTestsV2() : base(KmsKeyIdProvider.Instance)
{
kmsKeyID = _kmsKeyIdProvider.GetKmsId();
var rsa = RSA.Create();
var aes = Aes.Create();
var asymmetricEncryptionMaterials = new EncryptionMaterialsV2(rsa, AsymmetricAlgorithmType.RsaOaepSha1);
var symmetricEncryptionMaterials = new EncryptionMaterialsV2(aes, SymmetricAlgorithmType.AesGcm);
var kmsEncryptionMaterials =
new EncryptionMaterialsV2(kmsKeyID, KmsType.KmsContext, new Dictionary<string, string>());
var fileConfig = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2)
{
StorageMode = CryptoStorageMode.InstructionFile
};
var metadataConfig = new AmazonS3CryptoConfigurationV2(SecurityProfile.V2)
{
StorageMode = CryptoStorageMode.ObjectMetadata
};
s3EncryptionClientMetadataModeSymmetricWrap =
new AmazonS3EncryptionClientV2(metadataConfig, symmetricEncryptionMaterials);
s3EncryptionClientFileModeSymmetricWrap =
new AmazonS3EncryptionClientV2(fileConfig, symmetricEncryptionMaterials);
s3EncryptionClientMetadataModeAsymmetricWrap =
new AmazonS3EncryptionClientV2(metadataConfig, asymmetricEncryptionMaterials);
s3EncryptionClientFileModeAsymmetricWrap =
new AmazonS3EncryptionClientV2(fileConfig, asymmetricEncryptionMaterials);
s3EncryptionClientMetadataModeKMS = new AmazonS3EncryptionClientV2(metadataConfig, kmsEncryptionMaterials);
s3EncryptionClientFileModeKMS = new AmazonS3EncryptionClientV2(fileConfig, kmsEncryptionMaterials);
using (var writer = File.CreateText(filePath))
{
writer.Write(SampleContent);
}
bucketName = S3TestUtils.CreateBucketWithWait(s3EncryptionClientFileModeSymmetricWrap);
}
protected override void Dispose(bool disposing)
{
AmazonS3Util.DeleteS3BucketWithObjects(s3EncryptionClientMetadataModeSymmetricWrap, bucketName);
s3EncryptionClientMetadataModeSymmetricWrap.Dispose();
s3EncryptionClientFileModeSymmetricWrap.Dispose();
s3EncryptionClientMetadataModeAsymmetricWrap.Dispose();
s3EncryptionClientFileModeAsymmetricWrap.Dispose();
s3EncryptionClientMetadataModeKMS.Dispose();
s3EncryptionClientFileModeKMS.Dispose();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeSymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeAsymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeSymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeAsymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientFileModeKMS()
{
AssertExtensions.ExpectException(
() => { EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientFileModeKMS, bucketName); },
typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeKMS()
{
EncryptionTestsUtils.TestTransferUtility(s3EncryptionClientMetadataModeKMS, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrap, filePath, null, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestTransferUtilityS3EncryptionClientMetadataModeKMSCalculateMD5()
{
EncryptionTestsUtils.TestTransferUtilityCalculateMD5(s3EncryptionClientMetadataModeKMS, s3EncryptionClientMetadataModeKMS, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrap, filePath, null, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrap, filePath, null, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrap, filePath, null, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrap, null, SampleContentBytes, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrap, null, SampleContentBytes,
null, SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrap, null, SampleContentBytes, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrap, null, SampleContentBytes, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrap, null, null, SampleContent,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrap, null, null, SampleContent,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrap, null, null, "", "",
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrap, null, null, "", "",
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeSymmetricWrap, null, null, null, "",
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeAsymmetricWrap, null, null, null, "",
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeSymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeSymmetricWrap, null, null, SampleContent,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeAsymmetricWrap()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeAsymmetricWrap, null, null, SampleContent,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetFileUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMS, filePath, null, null, SampleContent,
bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMS, null, SampleContentBytes, null,
SampleContent, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetStreamUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMS, null, SampleContentBytes, null,
SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMS, null, null, SampleContent, SampleContent,
bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetZeroLengthContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMS, null, null, "", "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeKMS()
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientMetadataModeKMS, null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetContentUsingInstructionFileModeKMS()
{
AssertExtensions.ExpectException(
() =>
{
EncryptionTestsUtils.TestPutGet(s3EncryptionClientFileModeKMS, null, null, SampleContent,
SampleContent, bucketName);
}, typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void PutGetNullContentContentUsingMetadataModeKMSCalculateMD5()
{
EncryptionTestsUtils.TestPutGetCalculateMD5(s3EncryptionClientMetadataModeKMS, s3EncryptionClientMetadataModeKMS, null, null, null, "", bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeSymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeAsymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileSymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeSymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileAsymmetricWrap()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeAsymmetricWrap, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeKMS()
{
EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientMetadataModeKMS, bucketName);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestInstructionFileKMS()
{
AssertExtensions.ExpectException(
() => { EncryptionTestsUtils.MultipartEncryptionTest(s3EncryptionClientFileModeKMS, bucketName); },
typeof(AmazonClientException), InstructionAndKMSErrorMessage);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void MultipartEncryptionTestMetadataModeKMSCalculateMD5()
{
EncryptionTestsUtils.MultipartEncryptionTestCalculateMD5(s3EncryptionClientMetadataModeKMS, s3EncryptionClientMetadataModeKMS, bucketName);
}
#if AWS_APM_API
private static readonly Regex APMKMSErrorRegex = new Regex("Please use the synchronous version instead.");
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestGetObjectAPMKMS()
{
PutObjectRequest putObjectRequest = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
s3EncryptionClientMetadataModeKMS.PutObject(putObjectRequest);
GetObjectRequest getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = putObjectRequest.Key
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMS.EndGetObject(
s3EncryptionClientMetadataModeKMS.BeginGetObject(getObjectRequest, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestPutObjectAPMKMS()
{
PutObjectRequest request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
ContentBody = SampleContent,
};
AssertExtensions.ExpectException(() =>
{
PutObjectResponse response = s3EncryptionClientMetadataModeKMS.EndPutObject(
s3EncryptionClientMetadataModeKMS.BeginPutObject(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
[Fact]
[Trait(CategoryAttribute, "S3")]
public void TestInitiateMultipartUploadAPMKMS()
{
InitiateMultipartUploadRequest request = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html",
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClientMetadataModeKMS.EndInitiateMultipartUpload(
s3EncryptionClientMetadataModeKMS.BeginInitiateMultipartUpload(request, null, null));
}, typeof(NotSupportedException), APMKMSErrorRegex);
}
#endif
}
} | 491 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Security.Cryptography;
using System.IO;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public static class AssertExtensions
{
public static Exception ExpectException(Action action, Type exceptionType, String expectedMessage)
{
Action<string> validateMessage = expectedMessage == null ? (Action<string>)null :
(message) =>
{
Assert.Equal(expectedMessage, message);
};
return ExpectException(action, exceptionType, validateMessage);
}
public static Exception ExpectException(Action action, Type exceptionType, Regex messageRegex)
{
Action<string> validateMessage = messageRegex == null ? (Action<string>)null :
(message) =>
{
Assert.True(messageRegex.IsMatch(message),
string.Format("Expected exception message <{0}> to match regular expression <{1}>", message, messageRegex));
};
return ExpectException(action, exceptionType, validateMessage);
}
public static Exception ExpectException(Action action, Type exceptionType, Action<string> validateMessage)
{
bool gotException = false;
Exception exception = null;
try
{
action();
}
catch (Exception e)
{
exception = e;
if (exceptionType != null)
{
Assert.True(exceptionType == e.GetType(), e.ToString());
}
if (validateMessage != null)
{
validateMessage(e.Message);
}
gotException = true;
}
string message = (exceptionType == null) ?
"Failed to get an exception." :
String.Format("Failed to get expected exception: {0}", exceptionType.FullName);
Assert.True(gotException, message);
return exception;
}
}
}
| 84 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Security.Cryptography;
using System.IO;
using System.Text;
using Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities;
using Amazon.S3;
using Amazon.S3.Model;
using Amazon.S3.Transfer;
using Amazon.S3.Util;
using Amazon.Runtime;
using Amazon.KeyManagementService;
using Amazon.KeyManagementService.Model;
using Xunit;
using System.Text.RegularExpressions;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
internal partial class EncryptionTestsUtils
{
private const long MegaByteSize = 1048576;
public static void TestTransferUtility(IAmazonS3 s3EncryptionClient, string bucketName)
{
TestTransferUtility(s3EncryptionClient, s3EncryptionClient, bucketName);
}
public static void TestTransferUtility(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient, string bucketName)
{
var directory = TransferUtilityTests.CreateTestDirectory(10 * TransferUtilityTests.KILO_SIZE);
var keyPrefix = directory.Name;
var directoryPath = directory.FullName;
using (var transferUtility = new TransferUtility(s3EncryptionClient))
{
var uploadRequest = CreateUploadDirRequest(directoryPath, keyPrefix, bucketName);
transferUtility.UploadDirectory(uploadRequest);
var newDir = TransferUtilityTests.GenerateDirectoryPath();
transferUtility.DownloadDirectory(bucketName, keyPrefix, newDir);
TransferUtilityTests.ValidateDirectoryContents(s3DecryptionClient, bucketName, keyPrefix, directory);
}
}
public static void TestTransferUtilityCalculateMD5(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient, string bucketName)
{
var directory = TransferUtilityTests.CreateTestDirectory(10 * TransferUtilityTests.KILO_SIZE);
var keyPrefix = directory.Name;
var directoryPath = directory.FullName;
using (var transferUtility = new TransferUtility(s3EncryptionClient))
{
var uploadRequest = CreateUploadDirRequest(directoryPath, keyPrefix, bucketName);
uploadRequest.CalculateContentMD5Header = true;
transferUtility.UploadDirectory(uploadRequest);
var newDir = TransferUtilityTests.GenerateDirectoryPath();
transferUtility.DownloadDirectory(bucketName, keyPrefix, newDir);
TransferUtilityTests.ValidateDirectoryContents(s3DecryptionClient, bucketName, keyPrefix, directory);
}
}
private static TransferUtilityUploadDirectoryRequest CreateUploadDirRequest(string directoryPath, string keyPrefix, string bucketName)
{
var uploadRequest =
new TransferUtilityUploadDirectoryRequest
{
BucketName = bucketName,
Directory = directoryPath,
KeyPrefix = keyPrefix,
ServerSideEncryptionMethod = ServerSideEncryptionMethod.AES256,
SearchOption = SearchOption.AllDirectories,
SearchPattern = "*"
};
return uploadRequest;
}
public static void MultipartEncryptionTest(AmazonS3Client s3EncryptionClient, string bucketName)
{
MultipartEncryptionTest(s3EncryptionClient, s3EncryptionClient, bucketName);
}
public static void MultipartEncryptionTest(AmazonS3Client s3EncryptionClient, IAmazonS3 s3DecryptionClient, string bucketName)
{
var guid = Guid.NewGuid();
var filePath = Path.Combine(Path.GetTempPath(), $"multi-{guid}.txt");
var retrievedFilepath = Path.Combine(Path.GetTempPath(), $"retrieved-{guid}.txt");
var totalSize = MegaByteSize * 15;
UtilityMethods.GenerateFile(filePath, totalSize);
var key = $"key-{guid}";
Stream inputStream = File.OpenRead(filePath);
try
{
var initRequest = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html",
};
var initResponse = s3EncryptionClient.InitiateMultipartUpload(initRequest);
// Upload part 1
var uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 1,
PartSize = 5 * MegaByteSize,
InputStream = inputStream
};
var up1Response = s3EncryptionClient.UploadPart(uploadRequest);
// Upload part 2
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 2,
PartSize = 5 * MegaByteSize,
InputStream = inputStream
};
var up2Response = s3EncryptionClient.UploadPart(uploadRequest);
// Upload part 3
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 3,
InputStream = inputStream,
IsLastPart = true
};
var up3Response = s3EncryptionClient.UploadPart(uploadRequest);
var listPartRequest = new ListPartsRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
var listPartResponse = s3EncryptionClient.ListParts(listPartRequest);
Assert.Equal(3, listPartResponse.Parts.Count);
Assert.Equal(up1Response.PartNumber, listPartResponse.Parts[0].PartNumber);
Assert.Equal(up1Response.ETag, listPartResponse.Parts[0].ETag);
Assert.Equal(up2Response.PartNumber, listPartResponse.Parts[1].PartNumber);
Assert.Equal(up2Response.ETag, listPartResponse.Parts[1].ETag);
Assert.Equal(up3Response.PartNumber, listPartResponse.Parts[2].PartNumber);
Assert.Equal(up3Response.ETag, listPartResponse.Parts[2].ETag);
listPartRequest.MaxParts = 1;
listPartResponse = s3EncryptionClient.ListParts(listPartRequest);
Assert.Equal(1, listPartResponse.Parts.Count);
// Complete the response
var compRequest = new CompleteMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
compRequest.AddPartETags(up1Response, up2Response, up3Response);
var compResponse = s3EncryptionClient.CompleteMultipartUpload(compRequest);
Assert.Equal(bucketName, compResponse.BucketName);
Assert.NotNull(compResponse.ETag);
Assert.Equal(key, compResponse.Key);
Assert.NotNull(compResponse.Location);
// Get the file back from S3 and make sure it is still the same.
var getRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
var getResponse = s3DecryptionClient.GetObject(getRequest);
getResponse.WriteResponseStreamToFile(retrievedFilepath);
UtilityMethods.CompareFiles(filePath, retrievedFilepath);
var metaDataRequest = new GetObjectMetadataRequest()
{
BucketName = bucketName,
Key = key
};
var metaDataResponse = s3DecryptionClient.GetObjectMetadata(metaDataRequest);
Assert.Equal("text/html", metaDataResponse.Headers.ContentType);
}
finally
{
inputStream.Close();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
if (File.Exists(retrievedFilepath))
{
File.Delete(retrievedFilepath);
}
}
#if ASYNC_AWAIT
// run the async version of the same test
WaitForAsyncTask(MultipartEncryptionTestAsync(s3EncryptionClient, s3DecryptionClient, bucketName));
#elif AWS_APM_API
// run the APM version of the same test
MultipartEncryptionTestAPM(s3EncryptionClient, s3DecryptionClient, bucketName);
#endif
}
public static void MultipartEncryptionTestCalculateMD5(AmazonS3Client s3EncryptionClient, IAmazonS3 s3DecryptionClient, string bucketName)
{
var guid = Guid.NewGuid();
var filePath = Path.Combine(Path.GetTempPath(), $"multi-{guid}.txt");
var retrievedFilepath = Path.Combine(Path.GetTempPath(), $"retrieved-{guid}.txt");
var totalSize = MegaByteSize * 15;
UtilityMethods.GenerateFile(filePath, totalSize);
var key = $"key-{guid}";
Stream inputStream = File.OpenRead(filePath);
try
{
var initRequest = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html"
};
var initResponse = s3EncryptionClient.InitiateMultipartUpload(initRequest);
// Upload part 1
var uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 1,
PartSize = 5 * MegaByteSize,
InputStream = inputStream,
CalculateContentMD5Header = true
};
var up1Response = s3EncryptionClient.UploadPart(uploadRequest);
// Upload part 2
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 2,
PartSize = 5 * MegaByteSize,
InputStream = inputStream,
CalculateContentMD5Header = true
};
var up2Response = s3EncryptionClient.UploadPart(uploadRequest);
// Upload part 3
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 3,
InputStream = inputStream,
IsLastPart = true,
CalculateContentMD5Header = true
};
var up3Response = s3EncryptionClient.UploadPart(uploadRequest);
var listPartRequest = new ListPartsRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
var listPartResponse = s3EncryptionClient.ListParts(listPartRequest);
Assert.Equal(3, listPartResponse.Parts.Count);
Assert.Equal(up1Response.PartNumber, listPartResponse.Parts[0].PartNumber);
Assert.Equal(up1Response.ETag, listPartResponse.Parts[0].ETag);
Assert.Equal(up2Response.PartNumber, listPartResponse.Parts[1].PartNumber);
Assert.Equal(up2Response.ETag, listPartResponse.Parts[1].ETag);
Assert.Equal(up3Response.PartNumber, listPartResponse.Parts[2].PartNumber);
Assert.Equal(up3Response.ETag, listPartResponse.Parts[2].ETag);
listPartRequest.MaxParts = 1;
listPartResponse = s3EncryptionClient.ListParts(listPartRequest);
Assert.Equal(1, listPartResponse.Parts.Count);
// Complete the response
var compRequest = new CompleteMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
compRequest.AddPartETags(up1Response, up2Response, up3Response);
var compResponse = s3EncryptionClient.CompleteMultipartUpload(compRequest);
Assert.Equal(bucketName, compResponse.BucketName);
Assert.NotNull(compResponse.ETag);
Assert.Equal(key, compResponse.Key);
Assert.NotNull(compResponse.Location);
// Get the file back from S3 and make sure it is still the same.
var getRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
var getResponse = s3DecryptionClient.GetObject(getRequest);
getResponse.WriteResponseStreamToFile(retrievedFilepath);
UtilityMethods.CompareFiles(filePath, retrievedFilepath);
var metaDataRequest = new GetObjectMetadataRequest()
{
BucketName = bucketName,
Key = key
};
var metaDataResponse = s3DecryptionClient.GetObjectMetadata(metaDataRequest);
Assert.Equal("text/html", metaDataResponse.Headers.ContentType);
}
finally
{
inputStream.Close();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
if (File.Exists(retrievedFilepath))
{
File.Delete(retrievedFilepath);
}
}
#if ASYNC_AWAIT
// run the async version of the same test
WaitForAsyncTask(MultipartEncryptionTestAsync(s3EncryptionClient, s3DecryptionClient, bucketName));
#elif AWS_APM_API
// run the APM version of the same test
MultipartEncryptionTestAPM(s3EncryptionClient, s3DecryptionClient, bucketName);
#endif
}
internal static void TestPutGet(IAmazonS3 s3EncryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
TestPutGet(s3EncryptionClient, s3EncryptionClient, filePath, inputStreamBytes, contentBody,
expectedContent, bucketName);
}
internal static void TestPutGet(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
var request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
};
var response = s3EncryptionClient.PutObject(request);
TestGet(request.Key, expectedContent, s3DecryptionClient, bucketName);
#if ASYNC_AWAIT
// run the async version of the same test
WaitForAsyncTask(TestPutGetAsync(s3EncryptionClient, filePath, inputStreamBytes, contentBody, expectedContent, bucketName));
#elif AWS_APM_API
// Run the APM version of the same test
// KMS isn't supported for PutObject and GetObject in the APM.
if (!IsKMSEncryptionClient(s3EncryptionClient))
TestPutGetAPM(s3EncryptionClient, s3DecryptionClient, filePath, inputStreamBytes, contentBody, expectedContent, bucketName);
#endif
}
internal static void TestPutGetCalculateMD5(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
var request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
CalculateContentMD5Header = true
};
var response = s3EncryptionClient.PutObject(request);
TestGet(request.Key, expectedContent, s3DecryptionClient, bucketName);
#if ASYNC_AWAIT
// run the async version of the same test
WaitForAsyncTask(TestPutGetAsync(s3EncryptionClient, filePath, inputStreamBytes, contentBody, expectedContent, bucketName));
#elif AWS_APM_API
// Run the APM version of the same test
// KMS isn't supported for PutObject and GetObject in the APM.
if (!IsKMSEncryptionClient(s3EncryptionClient))
TestPutGetAPM(s3EncryptionClient, s3DecryptionClient, filePath, inputStreamBytes, contentBody, expectedContent, bucketName);
#endif
}
private static void TestGet(string key, string uploadedData, IAmazonS3 s3EncryptionClient, string bucketName)
{
var getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = key
};
using (var getObjectResponse = s3EncryptionClient.GetObject(getObjectRequest))
using (var stream = getObjectResponse.ResponseStream)
using (var reader = new StreamReader(stream))
{
var data = reader.ReadToEnd();
Assert.Equal(uploadedData, data);
}
}
public static void TestRangeGetDisabled(IAmazonS3 s3EncryptionClient, string bucketName)
{
var getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = "foo",
ByteRange = new ByteRange(2, 4)
};
AssertExtensions.ExpectException(() =>
{
s3EncryptionClient.GetObject(getObjectRequest);
}, typeof(NotSupportedException), RangeGetNotSupportedMessage);
#if ASYNC_AWAIT
AssertExtensions.ExpectException(() =>
{
WaitForAsyncTask(AttemptRangeGetAsync(s3EncryptionClient, getObjectRequest));
}, typeof(NotSupportedException), RangeGetNotSupportedMessage);
#elif AWS_APM_API
AssertExtensions.ExpectException(() =>
{
var asyncResult = s3EncryptionClient.BeginGetObject(getObjectRequest, null, null);
s3EncryptionClient.EndGetObject(asyncResult);
}, typeof(NotSupportedException), RangeGetNotSupportedMessage);
#endif
}
#if ASYNC_AWAIT
private static void WaitForAsyncTask(System.Threading.Tasks.Task asyncTask)
{
try
{
asyncTask.Wait();
}
catch (AggregateException e)
{
System.Runtime.ExceptionServices.ExceptionDispatchInfo.Capture(e.InnerException).Throw();
}
}
private static async System.Threading.Tasks.Task MultipartEncryptionTestAsync(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient, string bucketName)
{
var guid = Guid.NewGuid();
var filePath = Path.Combine(Path.GetTempPath(), $"multi-{guid}.txt");
var retrievedFilepath = Path.Combine(Path.GetTempPath(), $"retrieved-{guid}.txt");
var totalSize = MegaByteSize * 15;
UtilityMethods.GenerateFile(filePath, totalSize);
var key = $"key-{guid}";
Stream inputStream = File.OpenRead(filePath);
try
{
var initRequest = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html"
};
var initResponse =
await s3EncryptionClient.InitiateMultipartUploadAsync(initRequest).ConfigureAwait(false);
// Upload part 1
var uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 1,
PartSize = 5 * MegaByteSize,
InputStream = inputStream
};
var up1Response = await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
// Upload part 2
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 2,
PartSize = 5 * MegaByteSize,
InputStream = inputStream
};
var up2Response = await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
// Upload part 3
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 3,
InputStream = inputStream,
IsLastPart = true
};
var up3Response = await s3EncryptionClient.UploadPartAsync(uploadRequest).ConfigureAwait(false);
var listPartRequest = new ListPartsRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
var listPartResponse = await s3EncryptionClient.ListPartsAsync(listPartRequest).ConfigureAwait(false);
Assert.Equal(3, listPartResponse.Parts.Count);
Assert.Equal(up1Response.PartNumber, listPartResponse.Parts[0].PartNumber);
Assert.Equal(up1Response.ETag, listPartResponse.Parts[0].ETag);
Assert.Equal(up2Response.PartNumber, listPartResponse.Parts[1].PartNumber);
Assert.Equal(up2Response.ETag, listPartResponse.Parts[1].ETag);
Assert.Equal(up3Response.PartNumber, listPartResponse.Parts[2].PartNumber);
Assert.Equal(up3Response.ETag, listPartResponse.Parts[2].ETag);
listPartRequest.MaxParts = 1;
listPartResponse = await s3EncryptionClient.ListPartsAsync(listPartRequest).ConfigureAwait(false);
Assert.Equal(1, listPartResponse.Parts.Count);
// Complete the response
var compRequest = new CompleteMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
compRequest.AddPartETags(up1Response, up2Response, up3Response);
var compResponse =
await s3EncryptionClient.CompleteMultipartUploadAsync(compRequest).ConfigureAwait(false);
Assert.Equal(bucketName, compResponse.BucketName);
Assert.NotNull(compResponse.ETag);
Assert.Equal(key, compResponse.Key);
Assert.NotNull(compResponse.Location);
// Get the file back from S3 and make sure it is still the same.
var getRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
var getResponse =
await s3DecryptionClient.GetObjectAsync(getRequest).ConfigureAwait(false);
getResponse.WriteResponseStreamToFile(retrievedFilepath);
UtilityMethods.CompareFiles(filePath, retrievedFilepath);
var metaDataRequest = new GetObjectMetadataRequest()
{
BucketName = bucketName,
Key = key
};
var metaDataResponse =
await s3DecryptionClient.GetObjectMetadataAsync(metaDataRequest).ConfigureAwait(false);
Assert.Equal("text/html", metaDataResponse.Headers.ContentType);
}
finally
{
inputStream.Close();
if (File.Exists(filePath))
{
File.Delete(filePath);
}
if (File.Exists(retrievedFilepath))
{
File.Delete(retrievedFilepath);
}
}
}
private static async System.Threading.Tasks.Task TestPutGetAsync(IAmazonS3 s3EncryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
var request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
};
var response = await s3EncryptionClient.PutObjectAsync(request).ConfigureAwait(false);
await TestGetAsync(request.Key, expectedContent, s3EncryptionClient, bucketName).ConfigureAwait(false);
}
private static async System.Threading.Tasks.Task TestGetAsync(string key, string uploadedData, IAmazonS3 s3EncryptionClient, string bucketName)
{
var getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = key
};
using (var getObjectResponse = await s3EncryptionClient.GetObjectAsync(getObjectRequest).ConfigureAwait(false))
{
using (var stream = getObjectResponse.ResponseStream)
using (var reader = new StreamReader(stream))
{
var data = reader.ReadToEnd();
Assert.Equal(uploadedData, data);
}
}
}
public static async System.Threading.Tasks.Task AttemptRangeGetAsync(IAmazonS3 s3EncryptionClient, GetObjectRequest getObjectRequest)
{
await s3EncryptionClient.GetObjectAsync(getObjectRequest).ConfigureAwait(false);
}
#elif AWS_APM_API
private static readonly Regex APMKMSErrorRegex = new Regex("Please use the synchronous version instead.");
public static void MultipartEncryptionTestAPM(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient, string bucketName)
{
var guid = Guid.NewGuid();
var filePath = Path.Combine(Path.GetTempPath(), $"multi-{guid}.txt");
var retrievedFilepath = Path.Combine(Path.GetTempPath(), $"retrieved-{guid}.txt");
var totalSize = MegaByteSize * 15;
UtilityMethods.GenerateFile(filePath, totalSize);
string key = $"key-{guid}";
Stream inputStream = File.OpenRead(filePath);
try
{
InitiateMultipartUploadRequest initRequest = new InitiateMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
StorageClass = S3StorageClass.OneZoneInfrequentAccess,
ContentType = "text/html"
};
InitiateMultipartUploadResponse initResponse = null;
if (IsKMSEncryptionClient(s3EncryptionClient))
initResponse = s3EncryptionClient.InitiateMultipartUpload(initRequest);
else
initResponse = s3EncryptionClient.EndInitiateMultipartUpload(
s3EncryptionClient.BeginInitiateMultipartUpload(initRequest, null, null));
// Upload part 1
UploadPartRequest uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 1,
PartSize = 5 * MegaByteSize,
InputStream = inputStream,
};
UploadPartResponse up1Response = s3EncryptionClient.EndUploadPart(
s3EncryptionClient.BeginUploadPart(uploadRequest, null, null));
// Upload part 2
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 2,
PartSize = 5 * MegaByteSize,
InputStream = inputStream,
};
UploadPartResponse up2Response = s3EncryptionClient.EndUploadPart(
s3EncryptionClient.BeginUploadPart(uploadRequest, null, null));
// Upload part 3
uploadRequest = new UploadPartRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId,
PartNumber = 3,
InputStream = inputStream,
IsLastPart = true
};
UploadPartResponse up3Response = s3EncryptionClient.EndUploadPart(
s3EncryptionClient.BeginUploadPart(uploadRequest, null, null));
ListPartsRequest listPartRequest = new ListPartsRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
ListPartsResponse listPartResponse = s3EncryptionClient.EndListParts(
s3EncryptionClient.BeginListParts(listPartRequest, null, null));
Assert.Equal(3, listPartResponse.Parts.Count);
Assert.Equal(up1Response.PartNumber, listPartResponse.Parts[0].PartNumber);
Assert.Equal(up1Response.ETag, listPartResponse.Parts[0].ETag);
Assert.Equal(up2Response.PartNumber, listPartResponse.Parts[1].PartNumber);
Assert.Equal(up2Response.ETag, listPartResponse.Parts[1].ETag);
Assert.Equal(up3Response.PartNumber, listPartResponse.Parts[2].PartNumber);
Assert.Equal(up3Response.ETag, listPartResponse.Parts[2].ETag);
listPartRequest.MaxParts = 1;
listPartResponse = s3EncryptionClient.EndListParts(
s3EncryptionClient.BeginListParts(listPartRequest, null, null));
Assert.Equal(1, listPartResponse.Parts.Count);
// Complete the response
CompleteMultipartUploadRequest compRequest = new CompleteMultipartUploadRequest()
{
BucketName = bucketName,
Key = key,
UploadId = initResponse.UploadId
};
compRequest.AddPartETags(up1Response, up2Response, up3Response);
CompleteMultipartUploadResponse compResponse = s3EncryptionClient.EndCompleteMultipartUpload(
s3EncryptionClient.BeginCompleteMultipartUpload(compRequest, null, null));
Assert.Equal(bucketName, compResponse.BucketName);
Assert.NotNull(compResponse.ETag);
Assert.Equal(key, compResponse.Key);
Assert.NotNull(compResponse.Location);
// Get the file back from S3 and make sure it is still the same.
GetObjectRequest getRequest = new GetObjectRequest()
{
BucketName = bucketName,
Key = key
};
GetObjectResponse getResponse = null;
if (IsKMSEncryptionClient(s3EncryptionClient))
getResponse = s3DecryptionClient.GetObject(getRequest);
else
getResponse = s3DecryptionClient.EndGetObject(
s3DecryptionClient.BeginGetObject(getRequest, null, null));
getResponse.WriteResponseStreamToFile(retrievedFilepath);
UtilityMethods.CompareFiles(filePath, retrievedFilepath);
GetObjectMetadataRequest metaDataRequest = new GetObjectMetadataRequest()
{
BucketName = bucketName,
Key = key
};
GetObjectMetadataResponse metaDataResponse = s3DecryptionClient.EndGetObjectMetadata(
s3DecryptionClient.BeginGetObjectMetadata(metaDataRequest, null, null));
Assert.Equal("text/html", metaDataResponse.Headers.ContentType);
}
finally
{
inputStream.Close();
if (File.Exists(filePath))
File.Delete(filePath);
if (File.Exists(retrievedFilepath))
File.Delete(retrievedFilepath);
}
}
internal static bool IsKMSEncryptionClient(IAmazonS3 s3EncryptionClient)
{
var encryptionMaterials = ReflectionHelpers.Invoke(s3EncryptionClient, "EncryptionMaterials");
var kmsKeyID = ReflectionHelpers.Invoke(encryptionMaterials, "KMSKeyID");
return kmsKeyID != null;
}
private static void TestPutGetAPM(IAmazonS3 s3EncryptionClient, IAmazonS3 s3DecryptionClient,
string filePath, byte[] inputStreamBytes, string contentBody, string expectedContent, string bucketName)
{
PutObjectRequest request = new PutObjectRequest()
{
BucketName = bucketName,
Key = $"key-{Guid.NewGuid()}",
FilePath = filePath,
InputStream = inputStreamBytes == null ? null : new MemoryStream(inputStreamBytes),
ContentBody = contentBody,
};
PutObjectResponse response = s3EncryptionClient.EndPutObject(s3EncryptionClient.BeginPutObject(request, null, null));
TestGetAPM(request.Key, expectedContent, s3DecryptionClient, bucketName);
}
private static void TestGetAPM(string key, string uploadedData, IAmazonS3 s3EncryptionClient, string bucketName)
{
GetObjectRequest getObjectRequest = new GetObjectRequest
{
BucketName = bucketName,
Key = key
};
var asyncResult = s3EncryptionClient.BeginGetObject(getObjectRequest, null, null);
using (GetObjectResponse getObjectResponse = s3EncryptionClient.EndGetObject(asyncResult))
{
using (var stream = getObjectResponse.ResponseStream)
using (var reader = new StreamReader(stream))
{
string data = reader.ReadToEnd();
Assert.Equal(uploadedData, data);
}
}
}
#endif
}
} | 866 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.Collections.Generic;
using System.Linq;
using Amazon.KeyManagementService;
using Amazon.KeyManagementService.Model;
using Amazon.ResourceGroupsTaggingAPI;
using Amazon.ResourceGroupsTaggingAPI.Model;
using Tag = Amazon.KeyManagementService.Model.Tag;
namespace AWSSDK.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public class KmsKeyIdProvider
{
private string _kmsId;
private const string KmsIdTagKey = "Amazon-Extensions-S3-Encryption-Integration-Tests";
private static KmsKeyIdProvider _instance;
public static KmsKeyIdProvider Instance
{
get
{
if (_instance == null)
{
_instance = new KmsKeyIdProvider();
}
return _instance;
}
}
private KmsKeyIdProvider()
{
}
public string GetKmsId()
{
if (!string.IsNullOrEmpty(_kmsId))
{
return _kmsId;
}
using (var taggingClient = new AmazonResourceGroupsTaggingAPIClient())
{
var getResourcesRequest = new GetResourcesRequest
{
TagFilters = new List<TagFilter>
{
new TagFilter()
{
Key = KmsIdTagKey
}
}
};
var resourcesResponse = taggingClient.GetResources(getResourcesRequest);
if (resourcesResponse.ResourceTagMappingList.Count > 0)
{
var first = resourcesResponse.ResourceTagMappingList.First();
_kmsId = first.ResourceARN.Split('/').Last();
return _kmsId;
}
}
using (var kmsClient = new AmazonKeyManagementServiceClient())
{
var createKeyRequest = new CreateKeyRequest
{
Description = "Key for .NET integration tests.",
Origin = OriginType.AWS_KMS,
KeyUsage = KeyUsageType.ENCRYPT_DECRYPT,
Tags = new List<Tag>
{
new Tag()
{
TagKey = KmsIdTagKey,
TagValue = string.Empty
}
}
};
var response = kmsClient.CreateKey(createKeyRequest);
_kmsId = response.KeyMetadata.KeyId;
return _kmsId;
}
}
}
} | 100 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Reflection;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public static class ReflectionHelpers
{
private static readonly BindingFlags InstanceFlags =
BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance;
private static readonly BindingFlags StaticFlags =
BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Static;
/// <summary>
/// Invoke an instance member on the object.
/// Looks for a method, property, or field (in that order) on the object and calls it with the parameters provided.
/// For properties and fields 0 parameters means get, and 1 parameter means set.
/// For sets and void method calls, returns null.
/// </summary>
/// <param name="obj"></param>
/// <param name="memberName"></param>
/// <param name="parameters"></param>
/// <returns></returns>
public static object Invoke(object obj, string memberName, params object[] parameters)
{
return InvokeHelper(obj.GetType(), obj, memberName, parameters);
}
private static object InvokeHelper(Type type, object target, string memberName, object[] parameters)
{
BindingFlags flags = target == null ? StaticFlags : InstanceFlags;
var method = type.GetMethod(memberName, flags);
if (method == null)
{
var property = type.GetProperty(memberName, flags);
if (property == null)
{
var field = type.GetField(memberName, flags);
if (parameters.Length == 0)
{
// call the getter
return field.GetValue(target);
}
else if (parameters.Length == 1)
{
// call the setter
field.SetValue(target, parameters[0]);
return null;
}
else
{
throw new Exception("You can only call a field with 0 or 1 parameters.");
}
}
else
{
if (parameters.Length == 0)
{
// call the getter
return property.GetValue(target, null);
}
else if (parameters.Length == 1)
{
// call the setter
property.SetValue(target, parameters[0], null);
return null;
}
else
{
throw new Exception("You can only call a property with 0 or 1 parameters.");
}
}
}
else
{
return method.Invoke(target, parameters);
}
}
}
}
| 95 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Amazon.S3;
using Amazon.S3.Model;
using Amazon.S3.Util;
using System.Threading;
using Amazon;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public static class S3TestUtils
{
private const int MAX_SPIN_LOOPS = 100;
public static string CreateBucket(IAmazonS3 s3Client)
{
string bucketName = $"{UtilityMethods.SDK_TEST_PREFIX}-{Guid.NewGuid()}";
s3Client.PutBucket(new PutBucketRequest { BucketName = bucketName });
return bucketName;
}
public static string CreateBucketWithWait(IAmazonS3 s3Client)
{
string bucketName = CreateBucket(s3Client);
WaitForBucket(s3Client, bucketName);
return bucketName;
}
public static void WaitForBucket(IAmazonS3 client, string bucketName)
{
WaitForBucket(client, bucketName, 30);
}
public static void WaitForBucket(IAmazonS3 client, string bucketName, int maxSeconds)
{
var sleeper = UtilityMethods.ListSleeper.Create();
UtilityMethods.WaitUntilSuccess(() => {
//Check if a bucket exists by trying to put an object in it
var key = Guid.NewGuid().ToString() + "_existskey";
var res = client.PutObject(new PutObjectRequest
{
BucketName = bucketName,
Key = key,
ContentBody = "exists..."
});
try
{
client.Delete(bucketName, key, null);
}
catch
{
Console.WriteLine($"Eventual consistency error: failed to delete key {key} from bucket {bucketName}");
}
return true;
});
//Double check the bucket still exists using the DoesBucketExistV2 method
var exists = S3TestUtils.WaitForConsistency(() =>
{
return AmazonS3Util.DoesS3BucketExistV2(client, bucketName) ? (bool?)true : null;
});
}
public static T WaitForConsistency<T>(Func<T> loadFunction)
{
//First try waiting up to 60 seconds.
var firstWaitSeconds = 60;
try
{
return UtilityMethods.WaitUntilSuccess(loadFunction, 10, firstWaitSeconds);
}
catch
{
Console.WriteLine($"Eventual consistency wait: could not resolve eventual consistency after {firstWaitSeconds} seconds. Attempting to resolve...");
}
//Spin through request to try to get the expected result. As soon as we get a non null result use it.
for (var spinCounter = 0; spinCounter < MAX_SPIN_LOOPS; spinCounter++)
{
try
{
T result = loadFunction();
if (result != null)
{
if (spinCounter != 0)
{
//Only log that a wait happened if it didn't do it on the first time.
Console.WriteLine($"Eventual consistency wait successful on attempt {spinCounter + 1}.");
}
return result;
}
}
catch
{
}
Thread.Sleep(0);
}
//If we don't have an ok result then spend the normal wait period to wait for eventual consistency.
Console.WriteLine($"Eventual consistency wait: could not resolve eventual consistency after {MAX_SPIN_LOOPS}. Waiting normally...");
var lastWaitSeconds = 240; //4 minute wait.
return UtilityMethods.WaitUntilSuccess(loadFunction, 5, lastWaitSeconds);
}
}
}
| 130 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
using Amazon.Runtime;
using AWSSDK.Extensions.S3.Encryption.IntegrationTests.Utilities;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests
{
public abstract class TestBase
{
public const string CategoryAttribute = "Category";
static TestBase()
{
AWSConfigs.RegionEndpoint = RegionEndpoint.USWest2;
}
public TestBase()
{
}
public static TClient CreateClient<TClient>(AWSCredentials credentials = null,
RegionEndpoint endpoint = null) where TClient : AmazonServiceClient
{
endpoint = endpoint ?? AWSConfigs.RegionEndpoint;
if (credentials != null)
{
return (TClient)Activator.CreateInstance(typeof(TClient),
new object[] {credentials, endpoint});
}
else
{
return (TClient)Activator.CreateInstance(typeof(TClient),
new object[] {endpoint});
}
}
}
public abstract class TestBase<T> : TestBase, IDisposable
where T : AmazonServiceClient, IDisposable
{
protected readonly KmsKeyIdProvider _kmsKeyIdProvider;
private bool _disposed = false;
private T _client = null;
public T Client
{
get
{
if (_client == null)
{
_client = CreateClient<T>(endpoint: ActualEndpoint);
}
return _client;
}
}
public static string BaseDirectoryPath { get; set; }
protected virtual RegionEndpoint AlternateEndpoint
{
get { return null; }
}
protected RegionEndpoint ActualEndpoint
{
get { return (AlternateEndpoint ?? AWSConfigs.RegionEndpoint); }
}
static TestBase()
{
BaseDirectoryPath = Directory.GetCurrentDirectory();
}
public TestBase(KmsKeyIdProvider kmsKeyIdProvider)
{
_kmsKeyIdProvider = kmsKeyIdProvider;
}
#region IDispose implementation
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (_disposed)
return;
if (disposing)
{
this.Client.Dispose();
_disposed = true;
}
}
#endregion
}
} | 119 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.S3;
using Amazon.S3.Model;
using Amazon.S3.Util;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using Xunit;
#if ASYNC_AWAIT
using System.Threading.Tasks;
#endif
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public class TransferUtilityTests
{
public static readonly long MEG_SIZE = (int)Math.Pow(2, 20);
public static readonly long KILO_SIZE = (int)Math.Pow(2, 10);
public static readonly string BasePath = Path.Combine(Path.GetTempPath(), @"\test\transferutility\");
public static DirectoryInfo CreateTestDirectory(long size = 0)
{
if (size == 0)
size = 1 * MEG_SIZE;
var directoryPath = GenerateDirectoryPath();
for (int i = 0; i < 5; i++)
{
var filePath = Path.Combine(Path.Combine(directoryPath, i.ToString()), "file.txt");
UtilityMethods.GenerateFile(filePath, size);
}
return new DirectoryInfo(directoryPath);
}
public static string GenerateDirectoryPath(string baseName = "DirectoryTest")
{
var directoryName = UtilityMethods.GenerateName(baseName);
var directoryPath = Path.Combine(BasePath, directoryName);
return directoryPath;
}
public static void ValidateDirectoryContents(IAmazonS3 s3client, string bucketName, string keyPrefix, DirectoryInfo sourceDirectory)
{
ValidateDirectoryContents(s3client, bucketName, keyPrefix, sourceDirectory, null);
}
public static void ValidateDirectoryContents(IAmazonS3 s3client, string bucketName, string keyPrefix, DirectoryInfo sourceDirectory, string contentType)
{
var directoryPath = sourceDirectory.FullName;
var files = sourceDirectory.GetFiles("*", SearchOption.AllDirectories);
foreach (var file in files)
{
var filePath = file.FullName;
var key = filePath.Substring(directoryPath.Length + 1);
key = keyPrefix + "/" + key.Replace("\\", "/");
ValidateFileContents(s3client, bucketName, key, filePath, contentType);
}
}
public static void ValidateFileContents(IAmazonS3 s3client, string bucketName, string key, string path, string contentType)
{
var downloadPath = path + ".chk";
var request = new GetObjectRequest
{
BucketName = bucketName,
Key = key,
};
UtilityMethods.WaitUntil(() =>
{
using (var response = s3client.GetObject(request))
{
if (!string.IsNullOrEmpty(contentType))
{
Assert.Equal(contentType, response.Headers.ContentType);
}
response.WriteResponseStreamToFile(downloadPath);
}
return true;
}, sleepSeconds: 2, maxWaitSeconds: 10);
UtilityMethods.CompareFiles(path, downloadPath);
}
}
}
| 102 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.IO;
using System.Text;
using System.Threading;
using ThirdParty.MD5;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.IntegrationTests.Utilities
{
public static class UtilityMethods
{
public const string SDK_TEST_PREFIX = "aws-net-sdk";
public static void CompareFiles(string file1, string file2)
{
byte[] file1MD5 = computeHash(file1);
byte[] file2MD5 = computeHash(file2);
Assert.Equal(file1MD5.Length, file2MD5.Length);
for (int i = 0; i < file1MD5.Length; i++)
{
Assert.Equal(file1MD5[i], file2MD5[i]);
}
}
private static byte[] computeHash(string file)
{
Stream fileStream = File.OpenRead(file);
byte[] fileMD5 = new MD5Managed().ComputeHash(fileStream);
fileStream.Close();
return fileMD5;
}
public static T WaitUntilSuccess<T>(Func<T> loadFunction, int sleepSeconds = 5, int maxWaitSeconds = 300)
{
T result = default(T);
WaitUntil(() =>
{
try
{
result = loadFunction();
return result != null;
}
catch
{
return false;
}
}, sleepSeconds, maxWaitSeconds);
return result;
}
public static void WaitUntil(Func<bool> matchFunction, int sleepSeconds = 5, int maxWaitSeconds = 300)
{
if (sleepSeconds < 0) throw new ArgumentOutOfRangeException("sleepSeconds");
WaitUntil(matchFunction, new ListSleeper(sleepSeconds * 1000), maxWaitSeconds);
}
public static void WaitUntil(Func<bool> matchFunction, ListSleeper sleeper, int maxWaitSeconds = 300)
{
if (maxWaitSeconds < 0) throw new ArgumentOutOfRangeException("maxWaitSeconds");
var maxTime = TimeSpan.FromSeconds(maxWaitSeconds);
var endTime = DateTime.Now + maxTime;
while (DateTime.Now < endTime)
{
if (matchFunction())
return;
sleeper.Sleep();
}
throw new TimeoutException(
string.Format("Wait condition was not satisfied for {0} seconds", maxWaitSeconds));
}
public static void WriteFile(string path, string contents)
{
string fullPath = Path.GetFullPath(path);
new DirectoryInfo(Path.GetDirectoryName(fullPath)).Create();
File.WriteAllText(fullPath, contents);
}
public static void GenerateFile(string path, long size)
{
string contents = GenerateTestContents(size);
WriteFile(path, contents);
}
public static string GenerateTestContents(long size)
{
StringBuilder sb = new StringBuilder();
for (long i = 0; i < size; i++)
{
char c = (char)('a' + (i % 26));
sb.Append(c);
}
string contents = sb.ToString();
return contents;
}
public static string GenerateName(string name)
{
return name + Guid.NewGuid();
}
public class ListSleeper
{
private int attempt;
private int[] millisecondsList;
public ListSleeper(params int[] millisecondsList)
{
if (millisecondsList.Length < 1)
throw new ArgumentException("There must be at least one sleep period in millisecondsList.");
attempt = 0;
this.millisecondsList = millisecondsList;
}
public void Sleep()
{
// if there are more attempts than array elements just keep using the last one
var index = Math.Min(attempt, millisecondsList.Length - 1);
Thread.Sleep(millisecondsList[index]);
attempt++;
}
/// <summary>
/// Create a new exponential growth sleeper. The following sleeper will be created:
/// ListSleeper(500, 1000, 2000, 5000)
/// </summary>
/// <returns>A new ListSleeper with exponential growth</returns>
public static ListSleeper Create()
{
return new ListSleeper(500, 1000, 2000, 5000);
}
}
}
} | 157 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.IO;
using System.Linq;
using Amazon.Extensions.S3.Encryption;
using Amazon.Extensions.S3.Encryption.Util;
using Xunit;
using Xunit.Extensions;
namespace Amazon.Extensions.S3.Encryption.UnitTests
{
public class AesGcmDecryptStreamTests
{
private static readonly int[] ReadCounts = {1, 15, 16, 17, 32, 1024};
private const int TagBitsLength = 128;
[Theory]
[InlineData("DA2FDB0CED551AEB723D8AC1A267CEF3",
"",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"A5F5160B7B0B025757ACCDAA",
"",
"7AD0758C4FA9B8660AA0687B3E7BD517")]
[InlineData("4194935CF4524DF93D62FEDBC818D8AC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"0C5A8F5AF7F6064C0130EE64",
"3F4CC9A7451717E5E939D294A1362B32C274D06411188DAD76AEE3EE4DA46483EA4C1AF38B9B74D7AD2FD8E310CF82",
"AD563FD10E1EFA3F26753F46E09DB3A0")]
[InlineData("AD03EE2FD6048DB7158CEC55D3D760BC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"",
"1B813A16DDCB7F08D26E2541",
"ADD161BE957AE9EC3CEE6600C77FF81D64A80242A510A9D5AD872096C79073B61E8237FAA7D63A3301EA58EC11332C",
"01944370EC28601ADC989DE05A794AEB")]
[InlineData("20142E898CD2FD980FBF34DE6BC85C14DA7D57BD28F4AA5CF1728AB64E843142",
"",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"FB7B4A824E82DAA6C8BC1251",
"",
"81C0E42BB195E262CB3B3A74A0DAE1C8")]
[InlineData("D211F278A44EAB666B1021F4B4F60BA6B74464FA9CB7B134934D7891E1479169",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"6B5CD3705A733C1AD943D58A",
"4C25ABD66D3A1BCCE794ACAAF4CEFDF6D2552F4A82C50A98CB15B4812FF557ABE564A9CEFF15F32DCF5A5AA7894888",
"03EDE71EC952E65AE7B4B85CFEC7D304")]
[InlineData("CFE8BFE61B89AF53D2BECE744D27B78C9E4D74D028CE88ED10A422285B1201C9",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"",
"5F08EFBFB7BF5BA365D9EB1D",
"0A7E82F1E5C76C69679671EEAEE455936F2C4FCCD9DDF1FAA27075E2040644938920C5D16C69E4D93375487B9A80D4",
"04347D0C5B0E0DE89E033D04D0493DCA")]
public void Decrypt(string key, string expectedPlainText, string aad, string nonce, string cipherText, string tag)
{
var keyArray = Utils.HexStringToBytes(key);
var nonceArray = Utils.HexStringToBytes(nonce);
var aadArray = Utils.HexStringToBytes(aad);
var cipherTextArray = Utils.HexStringToBytes(cipherText + tag);
foreach (var readCount in ReadCounts)
{
// Decryption
var decryptedDataStream = DecryptHelper(cipherTextArray, keyArray, nonceArray, aadArray, readCount);
var decryptedPlainTextArray = decryptedDataStream.ToArray();
var decryptedPlainText = Utils.BytesToHexString(decryptedPlainTextArray);
// Final assert
Assert.Equal(expectedPlainText, decryptedPlainText);
}
}
[Theory]
[InlineData("4194935CF4524DF93D62FEDBC818D8AC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"0C5A8F5AF7F6064C0130EE64",
"3F4CC9A7451717E5E939D294A1362B32C274D06411188DAD76AEE3EE4DA46483EA4C1AF38B9B74D7AD2FD8E310CF82",
"AD563FD10E1EFA3F26753F46E09DB3A0")]
public void EncryptDecryptWithModification(string key, string expectedPlainText, string aad, string nonce, string cipherText, string tag)
{
const string failedToDecryptMessage = "Failed to decrypt: mac check in GCM failed";
var keyArray = Utils.HexStringToBytes(key);
var nonceArray = Utils.HexStringToBytes(nonce);
var aadArray = Utils.HexStringToBytes(aad);
var cipherTextArray = Utils.HexStringToBytes(cipherText + tag);
// Modify 16th byte
var dataModifiedCipherText = cipherTextArray.ToArray();
dataModifiedCipherText[15] = (byte)~dataModifiedCipherText[15];
Assert.Throws<AmazonCryptoException>(() =>
{
DecryptHelper(dataModifiedCipherText, keyArray, nonceArray, aadArray, 15);
});
// Modify last byte
var tagModifiedCipherText = cipherTextArray.ToArray();
tagModifiedCipherText[tagModifiedCipherText.Length-1] = (byte)~tagModifiedCipherText[tagModifiedCipherText.Length-1];
Assert.Throws<AmazonCryptoException>(() =>
{
DecryptHelper(tagModifiedCipherText, keyArray, nonceArray, aadArray, 15);
});
// No tag in the cipher text
var noTagCipherText = cipherTextArray.Take(cipherTextArray.Length - TagBitsLength).ToArray();
Assert.Throws<AmazonCryptoException>(() =>
{
DecryptHelper(noTagCipherText, keyArray, nonceArray, aadArray, 15);
});
// Modify aad
var modifiedAad = aadArray.ToArray();
modifiedAad[0] = (byte)~modifiedAad[0];
Assert.Throws<AmazonCryptoException>(() =>
{
DecryptHelper(cipherTextArray, keyArray, nonceArray, modifiedAad, 15);
});
// Modify key
var modifiedKey = keyArray.ToArray();
modifiedKey[0] = (byte)~modifiedKey[0];
Assert.Throws<AmazonCryptoException>(() =>
{
DecryptHelper(cipherTextArray, keyArray, nonceArray, modifiedAad, 15);
});
}
public static MemoryStream DecryptHelper(byte[] cipherTextArray, byte[] keyArray, byte[] nonceArray, byte[] aadArray, int readCount)
{
var decryptedDataStream = new MemoryStream();
using (var baseStream = new MemoryStream(cipherTextArray))
using (var stream = new AesGcmDecryptStream(baseStream, keyArray, nonceArray, TagBitsLength, aadArray))
{
int readBytes;
var buffer = new byte[readCount];
while ((readBytes = stream.Read(buffer, 0, readCount)) > 0)
{
decryptedDataStream.Write(buffer, 0, readBytes);
}
}
return decryptedDataStream;
}
}
} | 164 |
amazon-s3-encryption-client-dotnet | aws | C# | using System.Collections.Generic;
using System.Text;
using Amazon.Extensions.S3.Encryption.Internal;
using Amazon.Extensions.S3.Encryption.Util;
using Amazon.S3.Model;
using Moq;
using System.IO;
using Xunit.Extensions;
using Xunit;
namespace Amazon.Extensions.S3.Encryption.UnitTests
{
public class AesGcmDecryptUsingMetadata
{
/* Metadata extracted from an encrypted S3 object sample using AWS SES */
private static readonly byte[] DecryptedEnvelopeKeyKMS = { 52, 5, 73, 94, 237, 126, 210, 67, 26, 221, 182, 9, 236, 225, 197, 184, 147, 117, 60, 119, 141, 201, 21, 19, 2, 178, 62, 22, 120, 102, 137, 45 };
private static readonly string[] MetadataDictionaryKeys = { "x-amz-meta-x-amz-tag-len", "x-amz-meta-x-amz-unencrypted-content-length", "x-amz-meta-x-amz-wrap-alg",
"x-amz-meta-x-amz-matdesc" , "x-amz-meta-x-amz-key-v2" , "x-amz-meta-x-amz-cek-alg", "x-amz-meta-x-amz-iv" };
private static readonly string[] MetadataDictionaryValues = { "128", "3946", "kms", "{\"aws:ses:message-id\":\"lhne4tbq09c867b1ko1f3ho4fqfidcatruo26781\",\"aws:ses:rule-name\":\"encrypt-to-s3\",\"aws:ses:source-account\":\"{AWS_ACCOUNT_ID}\",\"kms_cmk_id\":\"arn:aws:kms:{AWS_ACCOUNT_ID}:{AWS_ACCOUNT_ID}:alias/aws/ses\"}",
"AQIDAHgN94fUlYO17HEeDorBZENwiXuQ3swljPjtZVKT/lVftAHJVBJhXNH02aAWuPsxxBo5AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMvq8jOYujNpL+coHxAgEQgDsRyJ3hFidKl5hw208WxBcNPCnlFmHyQ36HEewuORCoqGIor4uuhe3mcmVdGv2e5qob3Ju/C4hC3Ekpvg==",
"AES/GCM/NoPadding", "NUhrJ+0LoGyof/dj" };
private static readonly string KmsKeyId = "730b1bf4-9483-4834-b75e-8174ad092192";
[Theory]
[InlineData(SecurityProfile.V2)]
public void DecryptWithoutEncryptionContext_SecurityProfileV2(SecurityProfile securityProfile)
{
var encryptionMaterialsV2 = new EncryptionMaterialsV2(KmsKeyId, Primitives.KmsType.KmsContext, new Dictionary<string, string>());
var amazonS3EncryptionClientV2 = new AmazonS3EncryptionClientV2(new AmazonS3CryptoConfigurationV2(securityProfile), encryptionMaterialsV2);
var mockSetupDecryptionHandlerV2 = new Mock<SetupDecryptionHandlerV2>(amazonS3EncryptionClientV2);
mockSetupDecryptionHandlerV2.CallBase = true;
var mockObjectResponse = new Mock<GetObjectResponse>();
for (int i = 0; i < MetadataDictionaryKeys.Length; i++)
{
mockObjectResponse.Object.Metadata.Add(MetadataDictionaryKeys[i], MetadataDictionaryValues[i]);
}
Assert.Throws<AmazonCryptoException>(() =>
{
Utils.RunInstanceMethod(typeof(SetupDecryptionHandlerV2), "DecryptObjectUsingMetadata", mockSetupDecryptionHandlerV2.Object, new object[] { mockObjectResponse.Object, DecryptedEnvelopeKeyKMS });
});
}
[Theory]
[InlineData(SecurityProfile.V2AndLegacy)]
public void DecryptWithoutEncryptionContext_V2AndLegacy(SecurityProfile securityProfile)
{
var encryptionMaterialsV2 = new EncryptionMaterialsV2(KmsKeyId, Primitives.KmsType.KmsContext, new Dictionary<string, string>());
var amazonS3EncryptionClientV2 = new AmazonS3EncryptionClientV2(new AmazonS3CryptoConfigurationV2(securityProfile), encryptionMaterialsV2);
var mockSetupDecryptionHandlerV2 = new Mock<SetupDecryptionHandlerV2>(amazonS3EncryptionClientV2);
mockSetupDecryptionHandlerV2.CallBase = true;
var mockObjectResponse = new Mock<GetObjectResponse>();
mockObjectResponse.Object.ResponseStream = new MemoryStream(Encoding.UTF8.GetBytes(""));
for (int i = 0; i < MetadataDictionaryKeys.Length; i++)
{
mockObjectResponse.Object.Metadata.Add(MetadataDictionaryKeys[i], MetadataDictionaryValues[i]);
}
Utils.RunInstanceMethod(typeof(SetupDecryptionHandlerV2), "DecryptObjectUsingMetadata", mockSetupDecryptionHandlerV2.Object, new object[] { mockObjectResponse.Object, DecryptedEnvelopeKeyKMS });
Assert.True(mockObjectResponse.Object.ResponseStream.GetType() == typeof(AesGcmDecryptStream));
}
}
}
| 71 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System.IO;
using System.Linq;
using Amazon.Extensions.S3.Encryption.Util;
using Xunit;
using Xunit.Extensions;
namespace Amazon.Extensions.S3.Encryption.UnitTests
{
public class AesGcmEncryptStreamTests
{
private static readonly int[] ReadCounts = {1, 15, 16, 17, 32, 1024};
private const int TagBitsLength = 128;
[Theory]
[InlineData("DA2FDB0CED551AEB723D8AC1A267CEF3",
"",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"A5F5160B7B0B025757ACCDAA",
"",
"7AD0758C4FA9B8660AA0687B3E7BD517")]
[InlineData("4194935CF4524DF93D62FEDBC818D8AC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"0C5A8F5AF7F6064C0130EE64",
"3F4CC9A7451717E5E939D294A1362B32C274D06411188DAD76AEE3EE4DA46483EA4C1AF38B9B74D7AD2FD8E310CF82",
"AD563FD10E1EFA3F26753F46E09DB3A0")]
[InlineData("AD03EE2FD6048DB7158CEC55D3D760BC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"",
"1B813A16DDCB7F08D26E2541",
"ADD161BE957AE9EC3CEE6600C77FF81D64A80242A510A9D5AD872096C79073B61E8237FAA7D63A3301EA58EC11332C",
"01944370EC28601ADC989DE05A794AEB")]
[InlineData("20142E898CD2FD980FBF34DE6BC85C14DA7D57BD28F4AA5CF1728AB64E843142",
"",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"FB7B4A824E82DAA6C8BC1251",
"",
"81C0E42BB195E262CB3B3A74A0DAE1C8")]
[InlineData("D211F278A44EAB666B1021F4B4F60BA6B74464FA9CB7B134934D7891E1479169",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"6B5CD3705A733C1AD943D58A",
"4C25ABD66D3A1BCCE794ACAAF4CEFDF6D2552F4A82C50A98CB15B4812FF557ABE564A9CEFF15F32DCF5A5AA7894888",
"03EDE71EC952E65AE7B4B85CFEC7D304")]
[InlineData("CFE8BFE61B89AF53D2BECE744D27B78C9E4D74D028CE88ED10A422285B1201C9",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"",
"5F08EFBFB7BF5BA365D9EB1D",
"0A7E82F1E5C76C69679671EEAEE455936F2C4FCCD9DDF1FAA27075E2040644938920C5D16C69E4D93375487B9A80D4",
"04347D0C5B0E0DE89E033D04D0493DCA")]
public void Encrypt(string key, string plainText, string aad, string nonce, string expectedCipherText, string expectedTag)
{
var keyArray = Utils.HexStringToBytes(key);
var plainTextArray = Utils.HexStringToBytes(plainText);
var nonceArray = Utils.HexStringToBytes(nonce);
var aadArray = Utils.HexStringToBytes(aad);
foreach (var readCount in ReadCounts)
{
// Encryption
var encryptedDataStream = EncryptHelper(plainTextArray, keyArray, nonceArray, aadArray, readCount);
var cipherTextArray = encryptedDataStream.ToArray();
// Asserts
var tag = Utils.BytesToHexString(cipherTextArray.Skip(cipherTextArray.Length - TagBitsLength/8).Take(TagBitsLength/8).ToArray());
Assert.Equal(expectedTag, tag);
var cipherText = Utils.BytesToHexString(cipherTextArray.Take(cipherTextArray.Length - TagBitsLength/8).ToArray());
Assert.Equal(expectedCipherText, cipherText);
}
}
public static MemoryStream EncryptHelper(byte[] plainTextArray, byte[] keyArray, byte[] nonceArray, byte[] aadArray, int readCount)
{
var encryptedDataStream = new MemoryStream();
using (var baseStream = new MemoryStream(plainTextArray))
using (var stream = new AesGcmEncryptStream(baseStream, keyArray, nonceArray, TagBitsLength, aadArray))
{
int readBytes;
var buffer = new byte[readCount];
while ((readBytes = stream.Read(buffer, 0, readCount)) > 0)
{
encryptedDataStream.Write(buffer, 0, readBytes);
}
}
return encryptedDataStream;
}
}
} | 107 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Xunit;
using Xunit.Extensions;
namespace Amazon.Extensions.S3.Encryption.UnitTests
{
public class AesGcmStreamTests
{
private static readonly int[] ReadCounts = {1, 15, 16, 17, 32, 1024};
[Theory]
[InlineData("DA2FDB0CED551AEB723D8AC1A267CEF3",
"",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"A5F5160B7B0B025757ACCDAA")]
[InlineData("4194935CF4524DF93D62FEDBC818D8AC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"0C5A8F5AF7F6064C0130EE64")]
[InlineData("AD03EE2FD6048DB7158CEC55D3D760BC",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"",
"1B813A16DDCB7F08D26E2541")]
[InlineData("20142E898CD2FD980FBF34DE6BC85C14DA7D57BD28F4AA5CF1728AB64E843142",
"",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"FB7B4A824E82DAA6C8BC1251")]
[InlineData("D211F278A44EAB666B1021F4B4F60BA6B74464FA9CB7B134934D7891E1479169",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"6B5CD3705A733C1AD943D58A")]
[InlineData("CFE8BFE61B89AF53D2BECE744D27B78C9E4D74D028CE88ED10A422285B1201C9",
"167B5C226177733A782D616D7A2D63656B2D616C675C223A205C224145532F47434D2F4E6F50616464696E675C227D",
"",
"5F08EFBFB7BF5BA365D9EB1D")]
public void EncryptDecrypt(string key, string plainText, string aad, string nonce)
{
var keyArray = Utils.HexStringToBytes(key);
var plainTextArray = Utils.HexStringToBytes(plainText);
var nonceArray = Utils.HexStringToBytes(nonce);
var aadArray = Utils.HexStringToBytes(aad);
foreach (var readCount in ReadCounts)
{
// Encryption
var encryptedDataStream = AesGcmEncryptStreamTests.EncryptHelper(plainTextArray, keyArray, nonceArray, aadArray, readCount);
var cipherTextArray = encryptedDataStream.ToArray();
// Decryption
var decryptedDataStream = AesGcmDecryptStreamTests.DecryptHelper(cipherTextArray, keyArray, nonceArray, aadArray, readCount);
var decryptedPlainTextArray = decryptedDataStream.ToArray();
var decryptedPlainText = Utils.BytesToHexString(decryptedPlainTextArray);
// Final assert
Assert.Equal(plainText, decryptedPlainText);
}
}
}
} | 75 |
amazon-s3-encryption-client-dotnet | aws | C# | /*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using System;
using System.Reflection;
namespace Amazon.Extensions.S3.Encryption.UnitTests
{
public static class Utils
{
public static byte[] HexStringToBytes(string hexString)
{
var stringIndex = 0;
var byteIndex = 0;
var bytes = new byte[hexString.Length / 2];
while (hexString.Length > stringIndex + 1)
{
long lngDecimal = Convert.ToInt32(hexString.Substring(stringIndex, 2), 16);
bytes[byteIndex] = Convert.ToByte(lngDecimal);
stringIndex += 2;
byteIndex++;
}
return bytes;
}
public static string BytesToHexString(byte[] bytes)
{
var hexString = "";
for (var index = 0; index <= bytes.GetUpperBound(0); index++)
{
var number = int.Parse(bytes[index].ToString());
hexString += number.ToString("X").PadLeft(2, '0');
}
return hexString;
}
// Reflection is used to test inaccessible methods
public static object RunInstanceMethod(Type type, string strMethod, object objInstance, object[] objParams)
{
BindingFlags flags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic;
return RunMethod(type, strMethod, objInstance, objParams, flags);
}
private static object RunMethod(Type type, string strMethod, object objInstance, object[] objParams, BindingFlags flags)
{
MethodInfo methodInfo;
try
{
methodInfo = type.GetMethod(strMethod, flags);
if (methodInfo == null)
{
throw new ArgumentException("There is no method '" + strMethod + "' for type '" + type.ToString() + "'.");
}
object objReturn = methodInfo.Invoke(objInstance, objParams);
return objReturn;
}
catch (Exception e)
{
throw e.InnerException;
}
}
}
}
| 77 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
namespace Samples
{
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});
}
}
| 29 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
namespace Samples
{
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddCognitoIdentity();
services.AddRazorPages();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Error");
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapRazorPages();
});
}
}
}
| 61 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Identity;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
[assembly: HostingStartup(typeof(Samples.Areas.Identity.IdentityHostingStartup))]
namespace Samples.Areas.Identity
{
public class IdentityHostingStartup : IHostingStartup
{
public void Configure(IWebHostBuilder builder)
{
builder.ConfigureServices((context, services) => {
});
}
}
} | 18 |
aws-aspnet-cognito-identity-provider | aws | C# | using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;
using System;
using System.ComponentModel.DataAnnotations;
using System.Threading.Tasks;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class ChangePasswordModel : PageModel
{
private readonly CognitoUserManager<CognitoUser> _userManager;
private readonly ILogger<LoginWith2faModel> _logger;
public ChangePasswordModel(UserManager<CognitoUser> userManger, ILogger<LoginWith2faModel> logger)
{
_userManager = userManger as CognitoUserManager<CognitoUser>;
_logger = logger;
}
[BindProperty]
public InputModel Input { get; set; }
public string ReturnUrl { get; set; }
public class InputModel
{
[Required]
[EmailAddress]
[Display(Name = "Email")]
public string Email { get; set; }
[Required]
[DataType(DataType.Password)]
[Display(Name = "Current password")]
public string CurrentPassword { get; set; }
[Required]
[StringLength(100, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
[DataType(DataType.Password)]
[Display(Name = "New password")]
public string NewPassword { get; set; }
[DataType(DataType.Password)]
[Display(Name = "Confirm password")]
[Compare("NewPassword", ErrorMessage = "The password and confirmation password do not match.")]
public string ConfirmPassword { get; set; }
}
public void OnGet(string returnUrl = null)
{
ReturnUrl = returnUrl;
}
public async Task<IActionResult> OnPostAsync(string returnUrl = null)
{
if (!ModelState.IsValid)
{
return Page();
}
returnUrl = returnUrl ?? Url.Content("~/");
var user = await _userManager.FindByEmailAsync(Input.Email);
if (user == null)
{
throw new InvalidOperationException($"Unable to retrieve user.");
}
var result = await _userManager.ChangePasswordAsync(user, Input.CurrentPassword, Input.NewPassword);
if (result.Succeeded)
{
_logger.LogInformation("Changed password for user with ID '{UserId}'.", user.UserID);
return LocalRedirect(returnUrl);
}
else
{
_logger.LogInformation("Unable to change password for user with ID '{UserId}'.", user.UserID);
foreach (var item in result.Errors)
{
ModelState.AddModelError(item.Code, item.Description);
}
return Page();
}
}
}
}
| 94 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Security.Claims;
using System.Threading.Tasks;
using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class ConfirmAccountModel : PageModel
{
private readonly CognitoUserManager<CognitoUser> _userManager;
public ConfirmAccountModel(UserManager<CognitoUser> userManager)
{
_userManager = userManager as CognitoUserManager<CognitoUser>;
}
[BindProperty]
public InputModel Input { get; set; }
public string ReturnUrl { get; set; }
public class InputModel
{
[Required]
[Display(Name = "Code")]
public string Code { get; set; }
}
public void OnGet(string returnUrl = null)
{
ReturnUrl = returnUrl;
}
public async Task<IActionResult> OnPostAsync(string returnUrl = null)
{
returnUrl = returnUrl ?? Url.Content("~/");
if (ModelState.IsValid)
{
var userId = User.Claims.FirstOrDefault(c => c.Type == ClaimTypes.Name).Value;
var user = await _userManager.FindByIdAsync(userId);
if (user == null)
{
return NotFound($"Unable to load user with ID '{userId}'.");
}
var result = await _userManager.ConfirmSignUpAsync(user, Input.Code, true);
if (!result.Succeeded)
{
throw new InvalidOperationException($"Error confirming account for user with ID '{userId}':");
}
else
{
return returnUrl != null ? LocalRedirect(returnUrl) : Page() as IActionResult;
}
}
// If we got this far, something failed, redisplay form
return Page();
}
}
}
| 71 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Text.Encodings.Web;
using System.Text;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.AspNetCore.WebUtilities;
using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class ForgotPasswordModel : PageModel
{
private readonly CognitoUserManager<CognitoUser> _userManager;
public ForgotPasswordModel(UserManager<CognitoUser> userManager)
{
_userManager = userManager as CognitoUserManager<CognitoUser>;
}
[BindProperty]
public InputModel Input { get; set; }
public class InputModel
{
[Required]
[EmailAddress]
public string Email { get; set; }
}
public async Task<IActionResult> OnPostAsync()
{
if (ModelState.IsValid)
{
var user = await _userManager.FindByEmailAsync(Input.Email);
if (user == null || !(await _userManager.IsEmailConfirmedAsync(user)))
{
// Don't reveal that the user does not exist or is not confirmed
return RedirectToPage("./ResetPassword");
}
// Cognito will send notification to user with reset token the user can use to reset their password.
await user.ForgotPasswordAsync();
return RedirectToPage("./ResetPassword");
}
return Page();
}
}
}
| 59 |
aws-aspnet-cognito-identity-provider | aws | C# | using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Threading.Tasks;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class LoginModel : PageModel
{
private readonly SignInManager<CognitoUser> _signInManager;
private readonly ILogger<LoginModel> _logger;
public LoginModel(SignInManager<CognitoUser> signInManager, ILogger<LoginModel> logger)
{
_signInManager = signInManager;
_logger = logger;
}
[BindProperty]
public InputModel Input { get; set; }
public IList<AuthenticationScheme> ExternalLogins { get; set; }
public string ReturnUrl { get; set; }
[TempData]
public string ErrorMessage { get; set; }
public class InputModel
{
[Required]
public string UserName { get; set; }
[Required]
[DataType(DataType.Password)]
public string Password { get; set; }
[Display(Name = "Remember me?")]
public bool RememberMe { get; set; }
}
public async Task OnGetAsync(string returnUrl = null)
{
if (!string.IsNullOrEmpty(ErrorMessage))
{
ModelState.AddModelError(string.Empty, ErrorMessage);
}
returnUrl = returnUrl ?? Url.Content("~/");
// Clear the existing external cookie to ensure a clean login process
await HttpContext.SignOutAsync(IdentityConstants.ExternalScheme).ConfigureAwait(false);
ExternalLogins = (await _signInManager.GetExternalAuthenticationSchemesAsync().ConfigureAwait(false)).ToList();
ReturnUrl = returnUrl;
}
public async Task<IActionResult> OnPostAsync(string returnUrl = null)
{
returnUrl = returnUrl ?? Url.Content("~/");
if (ModelState.IsValid)
{
var result = await _signInManager.PasswordSignInAsync(Input.UserName, Input.Password, Input.RememberMe, lockoutOnFailure: false);
if (result.Succeeded)
{
_logger.LogInformation("User logged in.");
return LocalRedirect(returnUrl);
}
else if (result.RequiresTwoFactor)
{
return RedirectToPage("./LoginWith2fa", new { ReturnUrl = returnUrl, RememberMe = Input.RememberMe });
}
else if (result.IsCognitoSignInResult())
{
if (result is CognitoSignInResult cognitoResult)
{
if (cognitoResult.RequiresPasswordChange)
{
_logger.LogWarning("User password needs to be changed");
return RedirectToPage("./ChangePassword");
}
else if (cognitoResult.RequiresPasswordReset)
{
_logger.LogWarning("User password needs to be reset");
return RedirectToPage("./ResetPassword");
}
}
}
ModelState.AddModelError(string.Empty, "Invalid login attempt.");
return Page();
}
// If we got this far, something failed, redisplay form
return Page();
}
}
}
| 111 |
aws-aspnet-cognito-identity-provider | aws | C# | using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;
using System;
using System.ComponentModel.DataAnnotations;
using System.Threading.Tasks;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class LoginWith2faModel : PageModel
{
private readonly CognitoSignInManager<CognitoUser> _signInManager;
private readonly ILogger<LoginWith2faModel> _logger;
public LoginWith2faModel(SignInManager<CognitoUser> signInManager, ILogger<LoginWith2faModel> logger)
{
_signInManager = signInManager as CognitoSignInManager<CognitoUser>;
_logger = logger;
}
[BindProperty]
public InputModel Input { get; set; }
public bool RememberMe { get; set; }
public string ReturnUrl { get; set; }
public class InputModel
{
[Required]
[StringLength(7, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
[DataType(DataType.Text)]
[Display(Name = "2FA code")]
public string TwoFactorCode { get; set; }
[Display(Name = "Remember this machine")]
public bool RememberMachine { get; set; }
}
public async Task<IActionResult> OnGetAsync(bool rememberMe, string returnUrl = null)
{
// Ensure the user has gone through the username & password screen first
var user = await _signInManager.GetTwoFactorAuthenticationUserAsync();
if (user == null)
{
throw new InvalidOperationException($"Unable to load two-factor authentication user.");
}
ReturnUrl = returnUrl;
RememberMe = rememberMe;
return Page();
}
public async Task<IActionResult> OnPostAsync(bool rememberMe, string returnUrl = null)
{
if (!ModelState.IsValid)
{
return Page();
}
returnUrl = returnUrl ?? Url.Content("~/");
var user = await _signInManager.GetTwoFactorAuthenticationUserAsync();
if (user == null)
{
throw new InvalidOperationException($"Unable to load two-factor authentication user.");
}
var authenticatorCode = Input.TwoFactorCode.Replace(" ", string.Empty).Replace("-", string.Empty);
var result = await _signInManager.RespondToTwoFactorChallengeAsync(authenticatorCode, rememberMe, Input.RememberMachine);
if (result.Succeeded)
{
_logger.LogInformation("User with ID '{UserId}' logged in with 2fa.", user.UserID);
return LocalRedirect(returnUrl);
}
else
{
_logger.LogWarning("Invalid 2FA code entered for user with ID '{UserId}'.", user.UserID);
ModelState.AddModelError(string.Empty, "Invalid 2FA code.");
return Page();
}
}
}
}
| 94 |
aws-aspnet-cognito-identity-provider | aws | C# | using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;
using System.Threading.Tasks;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class LogoutModel : PageModel
{
private readonly SignInManager<CognitoUser> _signInManager;
private readonly ILogger<LogoutModel> _logger;
public LogoutModel(SignInManager<CognitoUser> signInManager, ILogger<LogoutModel> logger)
{
_signInManager = signInManager;
_logger = logger;
}
public void OnGet()
{
}
public async Task<IActionResult> OnPost(string returnUrl = null)
{
await _signInManager.SignOutAsync();
_logger.LogInformation("User logged out.");
if (returnUrl != null)
{
return LocalRedirect(returnUrl);
}
else
{
return Page();
}
}
}
} | 41 |
aws-aspnet-cognito-identity-provider | aws | C# | using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;
using System.ComponentModel.DataAnnotations;
using System.Threading.Tasks;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class RegisterModel : PageModel
{
private readonly SignInManager<CognitoUser> _signInManager;
private readonly CognitoUserManager<CognitoUser> _userManager;
private readonly ILogger<RegisterModel> _logger;
private readonly CognitoUserPool _pool;
public RegisterModel(
UserManager<CognitoUser> userManager,
SignInManager<CognitoUser> signInManager,
ILogger<RegisterModel> logger,
CognitoUserPool pool)
{
_userManager = userManager as CognitoUserManager<CognitoUser>;
_signInManager = signInManager;
_logger = logger;
_pool = pool;
}
[BindProperty]
public InputModel Input { get; set; }
public string ReturnUrl { get; set; }
public class InputModel
{
[Required]
[EmailAddress]
[Display(Name = "Email")]
public string Email { get; set; }
[Required]
[Display(Name = "UserName")]
public string UserName { get; set; }
[Required]
[StringLength(100, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
[DataType(DataType.Password)]
[Display(Name = "Password")]
public string Password { get; set; }
[DataType(DataType.Password)]
[Display(Name = "Confirm password")]
[Compare("Password", ErrorMessage = "The password and confirmation password do not match.")]
public string ConfirmPassword { get; set; }
}
public void OnGet(string returnUrl = null)
{
ReturnUrl = returnUrl;
}
public async Task<IActionResult> OnPostAsync(string returnUrl = null)
{
returnUrl = returnUrl ?? Url.Content("~/");
if (ModelState.IsValid)
{
var user = _pool.GetUser(Input.UserName);
user.Attributes.Add(CognitoAttribute.Email.AttributeName, Input.Email);
var result = await _userManager.CreateAsync(user, Input.Password);
if (result.Succeeded)
{
_logger.LogInformation("User created a new account with password.");
await _signInManager.SignInAsync(user, isPersistent: false);
return RedirectToPage("./ConfirmAccount");
}
foreach (var error in result.Errors)
{
ModelState.AddModelError(string.Empty, error.Description);
}
}
// If we got this far, something failed, redisplay form
return Page();
}
}
}
| 94 |
aws-aspnet-cognito-identity-provider | aws | C# | using Amazon.AspNetCore.Identity.Cognito;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.Extensions.Logging;
using System;
using System.ComponentModel.DataAnnotations;
using System.Threading.Tasks;
namespace Samples.Areas.Identity.Pages.Account
{
[AllowAnonymous]
public class ResetPasswordModel : PageModel
{
private readonly CognitoUserManager<CognitoUser> _userManager;
private readonly ILogger<LoginWith2faModel> _logger;
public ResetPasswordModel(UserManager<CognitoUser> userManger, ILogger<LoginWith2faModel> logger)
{
_userManager = userManger as CognitoUserManager<CognitoUser>;
_logger = logger;
}
[BindProperty]
public InputModel Input { get; set; }
public string ReturnUrl { get; set; }
public class InputModel
{
[Required]
[EmailAddress]
[Display(Name = "Email")]
public string Email { get; set; }
[Required]
[DataType(DataType.Text)]
[Display(Name = "Reset Token")]
public string ResetToken { get; set; }
[Required]
[StringLength(100, ErrorMessage = "The {0} must be at least {2} and at max {1} characters long.", MinimumLength = 6)]
[DataType(DataType.Password)]
[Display(Name = "New password")]
public string NewPassword { get; set; }
[DataType(DataType.Password)]
[Display(Name = "Confirm password")]
[Compare("NewPassword", ErrorMessage = "The password and confirmation password do not match.")]
public string ConfirmPassword { get; set; }
}
public void OnGet(string returnUrl = null)
{
ReturnUrl = returnUrl;
}
public async Task<IActionResult> OnPostAsync(string returnUrl = null)
{
if (!ModelState.IsValid)
{
return Page();
}
returnUrl = returnUrl ?? Url.Content("~/");
var user = await _userManager.FindByEmailAsync(Input.Email);
if (user == null)
{
throw new InvalidOperationException($"Unable to retrieve user.");
}
var result = await _userManager.ResetPasswordAsync(user, Input.ResetToken, Input.NewPassword);
if (result.Succeeded)
{
_logger.LogInformation("Password reset for user with ID '{UserId}'.", user.UserID);
return LocalRedirect(returnUrl);
}
else
{
_logger.LogInformation("Unable to rest password for user with ID '{UserId}'.", user.UserID);
foreach (var item in result.Errors)
{
ModelState.AddModelError(item.Code, item.Description);
}
return Page();
}
}
}
}
| 94 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
namespace Samples.Pages
{
public class ErrorModel : PageModel
{
public string RequestId { get; set; }
public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
public void OnGet()
{
RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier;
}
}
}
| 23 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
namespace Samples.Pages
{
public class IndexModel : PageModel
{
public void OnGet()
{
}
}
}
| 18 |
aws-aspnet-cognito-identity-provider | aws | C# | using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
namespace Samples.Pages
{
public class PrivacyModel : PageModel
{
public void OnGet()
{
}
}
} | 16 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoAttribute
{
// This list of default attributes follows the OpenID Connect specification.
// Source: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html
// Some default attributes might be required when registering a user depending on the user pool configuration.
public static readonly CognitoAttribute Address = new CognitoAttribute("address");
public static readonly CognitoAttribute BirthDate = new CognitoAttribute("birthdate");
public static readonly CognitoAttribute Email = new CognitoAttribute("email");
public static readonly CognitoAttribute EmailVerified = new CognitoAttribute("email_verified");
public static readonly CognitoAttribute Enabled = new CognitoAttribute("status");
public static readonly CognitoAttribute FamilyName = new CognitoAttribute("family_name");
public static readonly CognitoAttribute Gender = new CognitoAttribute("gender");
public static readonly CognitoAttribute GivenName = new CognitoAttribute("given_name");
public static readonly CognitoAttribute Locale = new CognitoAttribute("locale");
public static readonly CognitoAttribute MiddleName = new CognitoAttribute("middle_name");
public static readonly CognitoAttribute Name = new CognitoAttribute("name");
public static readonly CognitoAttribute NickName = new CognitoAttribute("nickname");
public static readonly CognitoAttribute PhoneNumber = new CognitoAttribute("phone_number");
public static readonly CognitoAttribute PhoneNumberVerified = new CognitoAttribute("phone_number_verified");
public static readonly CognitoAttribute Picture = new CognitoAttribute("picture");
public static readonly CognitoAttribute PreferredUsername = new CognitoAttribute("preferred_username");
public static readonly CognitoAttribute Profile = new CognitoAttribute("profile");
public static readonly CognitoAttribute Sub = new CognitoAttribute("sub");
public static readonly CognitoAttribute UpdatedAt = new CognitoAttribute("updated_at");
public static readonly CognitoAttribute UserName = new CognitoAttribute("username");
public static readonly CognitoAttribute UserStatus = new CognitoAttribute("cognito:user_status");
public static readonly CognitoAttribute Website = new CognitoAttribute("website");
public static readonly CognitoAttribute ZoneInfo = new CognitoAttribute("zoneinfo");
// List of attributes filterable through the ListUsers API.
public static readonly string[] FilterableAttributes = { Email.AttributeName, Enabled.AttributeName, GivenName.AttributeName,
FamilyName.AttributeName, PhoneNumber.AttributeName, PreferredUsername.AttributeName, Name.AttributeName, Sub.AttributeName, UserName.AttributeName, UserStatus.AttributeName };
public string AttributeName { get; }
public CognitoAttribute(string attributeName)
{
AttributeName = attributeName;
}
public override string ToString()
{
return AttributeName;
}
}
}
| 66 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoAttributeFilterType
{
public static readonly CognitoAttributeFilterType IsEqualTo = new CognitoAttributeFilterType("=");
public static readonly CognitoAttributeFilterType StartsWith = new CognitoAttributeFilterType("^=");
private readonly string _filterType;
private CognitoAttributeFilterType(string filterType)
{
_filterType = filterType;
}
public override string ToString()
{
return _filterType;
}
}
}
| 36 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Microsoft.AspNetCore.Identity;
namespace Amazon.AspNetCore.Identity.Cognito
{
/// <summary>
/// Implements ILookupNormalizer by returning the key without changes as Cognito is case sensitive.
/// For instance, a group named 'Test' is not the same as a group named 'test' in Cognito.
/// The same is applicable to usernames.
/// </summary>
public class CognitoKeyNormalizer : ILookupNormalizer
{
#if NETSTANDARD2_0
/// <summary>
/// Normalizes the key to be be used by Cognito.
/// </summary>
/// <param name="key">The key to normalize</param>
/// <returns></returns>
public string Normalize(string key)
{
// Cognito does not handle normalization, returning the key as is.
return key;
}
#endif
#if NETCOREAPP3_1
/// <summary>
/// Returns a normalized representation of the specified <paramref name="name"/>.
/// </summary>
/// <param name="name">The key to normalize.</param>
/// <returns>A normalized representation of the specified <paramref name="name"/>.</returns>
public string NormalizeName(string name)
{
// Cognito does not handle normalization, returning the name as is.
return name;
}
/// <summary>
/// Returns a normalized representation of the specified <paramref name="email"/>.
/// </summary>
/// <param name="email">The email to normalize.</param>
/// <returns>A normalized representation of the specified <paramref name="email"/>.</returns>
public string NormalizeEmail(string email)
{
// Cognito does not handle normalization, returning the email as is.
return email;
}
#endif
}
}
| 65 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Identity;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoPasswordValidator : IPasswordValidator<CognitoUser>
{
// This is the list of what is considered to be a special characters by Cognito
// See: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-policies.html
private static readonly char[] CognitoSymbols = { '^', '$', '*', '.', '[', ']', '{', '}', '(', ')', '?', '-', '"', '!', '@', '#', '%', '&', '/', '\\', ',', '>', '<', '\'', ':', ';', '|', '_', '~', '`' };
/// <summary>
/// Validates a password based on a Cognito user pool password policy as an asynchronous operation.
/// </summary>
/// <param name="manager">The <see cref="UserManager{CognitoUser}"/> to retrieve the <paramref name="user"/> properties from.</param>
/// <param name="user">The user whose password should be validated.</param>
/// <param name="password">The password supplied for validation</param>
/// <returns>The task object representing the asynchronous operation, containing the <see cref="IdentityResult"/>
/// of the operation.
public async Task<IdentityResult> ValidateAsync(UserManager<CognitoUser> manager, CognitoUser user, string password)
{
// Retrieve the password policy set by the user's user pool
var passwordPolicy = await user.UserPool.GetPasswordPolicyTypeAsync().ConfigureAwait(false);
var errorDescriber = new IdentityErrorDescriber();
var errors = new List<IdentityError>();
if (password.Length < passwordPolicy.MinimumLength)
{
errors.Add(errorDescriber.PasswordTooShort(passwordPolicy.MinimumLength));
}
if (!password.Any(char.IsLower) && passwordPolicy.RequireLowercase)
{
errors.Add(errorDescriber.PasswordRequiresLower());
}
if (!password.Any(char.IsUpper) && passwordPolicy.RequireUppercase)
{
errors.Add(errorDescriber.PasswordRequiresUpper());
}
if (!password.Any(char.IsNumber) && passwordPolicy.RequireNumbers)
{
errors.Add(errorDescriber.PasswordRequiresDigit());
}
var passwordContainsASymbol = password.IndexOfAny(CognitoSymbols) >= 0;
if (!passwordContainsASymbol && passwordPolicy.RequireSymbols)
{
errors.Add(errorDescriber.PasswordRequiresNonAlphanumeric());
}
if (errors.Count > 0)
{
return IdentityResult.Failed(errors.ToArray());
}
else
{
return IdentityResult.Success;
}
}
}
}
| 83 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoRole
{
public CognitoRole(string name, string description, int precedence, string roleArn = null)
{
Name = name;
Description = description;
Precedence = precedence;
RoleArn = roleArn;
}
public string Name { get; }
public string Description { get; set; }
public int Precedence { get; set; }
public string RoleArn { get; set; }
}
}
| 37 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.CognitoIdentityProvider;
using Amazon.CognitoIdentityProvider.Model;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Identity;
using System;
using System.Threading;
using System.Threading.Tasks;
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoRoleStore<TRole> : IRoleStore<TRole> where TRole : CognitoRole
{
private IAmazonCognitoIdentityProvider _cognitoClient;
private CognitoUserPool _pool;
public CognitoRoleStore(IAmazonCognitoIdentityProvider cognitoClient, CognitoUserPool pool)
{
_cognitoClient = cognitoClient ?? throw new ArgumentNullException(nameof(cognitoClient));
_pool = pool ?? throw new ArgumentNullException(nameof(pool));
}
/// <summary>
/// Creates a new role in the store as an asynchronous operation.
/// </summary>
/// <param name="role">The role to create in the store.</param>
/// <returns>A <see cref="Task{TResult}"/> that represents the <see cref="IdentityResult"/> of the asynchronous query.</returns>
public virtual async Task<IdentityResult> CreateAsync(TRole role, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
if (role == null)
{
throw new ArgumentNullException(nameof(role));
}
await _cognitoClient.CreateGroupAsync(new CreateGroupRequest()
{
Description = role.Description,
GroupName = role.Name,
Precedence = role.Precedence,
RoleArn = role.RoleArn,
UserPoolId = _pool.PoolID
}, cancellationToken).ConfigureAwait(false);
return IdentityResult.Success;
}
/// <summary>
/// Deletes a role from the store as an asynchronous operation.
/// </summary>
/// <param name="role">The role to delete from the store.</param>
/// <returns>A <see cref="Task{TResult}"/> that represents the <see cref="IdentityResult"/> of the asynchronous query.</returns>
public virtual async Task<IdentityResult> DeleteAsync(TRole role, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
if (role == null)
{
throw new ArgumentNullException(nameof(role));
}
await _cognitoClient.DeleteGroupAsync(new DeleteGroupRequest()
{
GroupName = role.Name,
UserPoolId = _pool.PoolID
}, cancellationToken).ConfigureAwait(false);
return IdentityResult.Success;
}
/// <summary>
/// Finds the role that has the specified normalized name as an asynchronous operation.
/// </summary>
/// <param name="roleName">The role name to look for.</param>
/// <returns>A <see cref="Task{TResult}"/> that represents the result of the look up.</returns>
public virtual async Task<TRole> FindByNameAsync(string roleName, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
var response = await _cognitoClient.GetGroupAsync(new GetGroupRequest()
{
GroupName = roleName,
UserPoolId = _pool.PoolID
}, cancellationToken).ConfigureAwait(false);
return new CognitoRole(response.Group.GroupName, response.Group.Description,
response.Group.Precedence, response.Group.RoleArn) as TRole;
}
/// <summary>
/// Updates a role in a store as an asynchronous operation.
/// </summary>
/// <param name="role">The role to update in the store.</param>
/// <returns>A <see cref="Task{TResult}"/> that represents the <see cref="IdentityResult"/> of the asynchronous query.</returns>
public virtual async Task<IdentityResult> UpdateAsync(TRole role, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
if (role == null)
{
throw new ArgumentNullException(nameof(role));
}
await _cognitoClient.UpdateGroupAsync(new UpdateGroupRequest()
{
Description = role.Description,
GroupName = role.Name,
Precedence = role.Precedence,
RoleArn = role.RoleArn,
UserPoolId = _pool.PoolID
}, cancellationToken).ConfigureAwait(false);
return IdentityResult.Success;
}
/// <summary>
/// Gets the name of a role as an asynchronous operation.
/// </summary>
/// <param name="role">The role whose name should be returned.</param>
/// <returns>A <see cref="Task{TResult}"/> that contains the name of the role.</returns>
public virtual Task<string> GetRoleNameAsync(TRole role, CancellationToken cancellationToken)
{
return Task.FromResult(role.Name);
}
/// <summary>
/// Sets the name of a role in the store as an asynchronous operation.
/// This is currently not supported as changing a role name is not supported by Cognito.
/// </summary>
/// <param name="role">The role whose name should be set.</param>
/// <param name="roleName">The name of the role.</param>
/// <returns>The <see cref="Task"/> that represents the asynchronous operation.</returns>
public Task SetRoleNameAsync(TRole role, string roleName, CancellationToken cancellationToken)
{
throw new NotSupportedException("Changing role names in not supported.");
}
/// <summary>
/// Gets the ID for a role from the store as an asynchronous operation.
/// This is currently not supported as Cognito does not expose role ids.
/// Use GetRoleNameAsync() instead.
/// </summary>
/// <param name="role">The role whose ID should be returned.</param>
/// <returns>A <see cref="Task{TResult}"/> that contains the ID of the role.</returns>
public Task<string> GetRoleIdAsync(TRole role, CancellationToken cancellationToken)
{
throw new NotSupportedException("Cognito does not expose role ids, use GetRoleNameAsync() instead");
}
/// <summary>
/// Finds the role that has the specified ID as an asynchronous operation.
/// This is currently not supported as Cognito does not expose role ids.
/// Use FindByNameAsync() instead.
/// </summary>
/// <param name="roleId">The role ID to look for.</param>
/// <returns>A <see cref="Task{TResult}"/> that result of the look up.</returns>
public Task<TRole> FindByIdAsync(string roleId, CancellationToken cancellationToken)
{
throw new NotSupportedException("Cognito does not expose role ids, use FindByNameAsync() instead");
}
/// <summary>
/// Set a role's normalized name as an asynchronous operation.
/// This is currently not supported as Cognito is case-sensitive and does not support normalized role names.
/// Use SetRoleNameAsync() instead.
/// </summary>
/// <param name="role">The role whose normalized name should be set.</param>
/// <param name="normalizedName">The normalized name to set</param>
/// <returns>The <see cref="Task"/> that represents the asynchronous operation.</returns>
public Task SetNormalizedRoleNameAsync(TRole role, string normalizedName, CancellationToken cancellationToken)
{
throw new NotSupportedException("Cognito is case-sensitive and does not support normalized role names. Use SetRoleNameAsync() instead");
}
/// <summary>
/// Get a role's normalized name as an asynchronous operation.
/// This is currently not supported as Cognito is case-sensitive and does not support normalized role names.
/// Use GetRoleNameAsync() instead.
/// </summary>
/// <param name="role">The role whose normalized name should be retrieved.</param>
/// <returns>A <see cref="Task{TResult}"/> that contains the name of the role.</returns>
public Task<string> GetNormalizedRoleNameAsync(TRole role, CancellationToken cancellationToken)
{
throw new NotSupportedException("Cognito is case-sensitive and does not support normalized role names. Use GetRoleNameAsync() instead");
}
#region IDisposable
private bool disposed = false;
protected virtual void Dispose(bool disposing)
{
if (disposed)
return;
disposed = true;
}
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
#endregion
}
}
| 221 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.CognitoIdentityProvider;
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Identity;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Microsoft.IdentityModel.Protocols.OpenIdConnect;
using System;
using System.Collections.Generic;
using System.Security.Claims;
using System.Threading.Tasks;
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoSignInManager<TUser> : SignInManager<TUser> where TUser : CognitoUser
{
private readonly CognitoUserManager<TUser> _userManager;
private readonly CognitoUserClaimsPrincipalFactory<TUser> _claimsFactory;
private readonly IHttpContextAccessor _contextAccessor;
private const string Cognito2FAAuthWorkflowKey = "Cognito2FAAuthWorkflowId";
private const string Cognito2FAChallengeNameType = "Cognito2FAChallengeNameType";
private const string Cognito2FAProviderKey = "Amazon Cognito 2FA";
#if NETCOREAPP3_1
public CognitoSignInManager(UserManager<TUser> userManager,
IHttpContextAccessor contextAccessor,
IUserClaimsPrincipalFactory<TUser> claimsFactory,
IOptions<IdentityOptions> optionsAccessor,
ILogger<SignInManager<TUser>> logger,
IAuthenticationSchemeProvider schemes,
IUserConfirmation<TUser> confirmation) : base(userManager, contextAccessor, claimsFactory, optionsAccessor, logger, schemes, confirmation)
{
if (userManager == null)
throw new ArgumentNullException(nameof(userManager));
if (claimsFactory == null)
throw new ArgumentNullException(nameof(claimsFactory));
if (userManager is CognitoUserManager<TUser>)
_userManager = userManager as CognitoUserManager<TUser>;
else
throw new ArgumentException("The userManager must be of type CognitoUserManager<TUser>", nameof(userManager));
if (claimsFactory is CognitoUserClaimsPrincipalFactory<TUser>)
_claimsFactory = claimsFactory as CognitoUserClaimsPrincipalFactory<TUser>;
else
throw new ArgumentException("The claimsFactory must be of type CognitoUserClaimsPrincipalFactory<TUser>", nameof(claimsFactory));
_contextAccessor = contextAccessor ?? throw new ArgumentNullException(nameof(contextAccessor));
}
#endif
#if NETSTANDARD2_0
public CognitoSignInManager(UserManager<TUser> userManager,
IHttpContextAccessor contextAccessor,
IUserClaimsPrincipalFactory<TUser> claimsFactory,
IOptions<IdentityOptions> optionsAccessor,
ILogger<SignInManager<TUser>> logger,
IAuthenticationSchemeProvider schemes) : base(userManager, contextAccessor, claimsFactory, optionsAccessor, logger, schemes)
{
if (userManager == null)
throw new ArgumentNullException(nameof(userManager));
if (claimsFactory == null)
throw new ArgumentNullException(nameof(claimsFactory));
if (userManager is CognitoUserManager<TUser>)
_userManager = userManager as CognitoUserManager<TUser>;
else
throw new ArgumentException("The userManager must be of type CognitoUserManager<TUser>", nameof(userManager));
if (claimsFactory is CognitoUserClaimsPrincipalFactory<TUser>)
_claimsFactory = claimsFactory as CognitoUserClaimsPrincipalFactory<TUser>;
else
throw new ArgumentException("The claimsFactory must be of type CognitoUserClaimsPrincipalFactory<TUser>", nameof(claimsFactory));
_contextAccessor = contextAccessor ?? throw new ArgumentNullException(nameof(contextAccessor));
}
#endif
/// <summary>
/// Attempts to sign in the specified <paramref name="userId"/> and <paramref name="password"/> combination
/// as an asynchronous operation.
/// </summary>
/// <param name="userId">The user id to sign in with. This can be a username, an email, or a phone number depending on the user pool policy.</param>
/// <param name="password">The password to attempt to sign in with.</param>
/// <param name="isPersistent">Flag indicating whether the sign-in cookie should persist after the browser is closed.</param>
/// <param name="lockoutOnFailure">Cognito does not handle account lock out. This parameter must be set to false, or a NotSupportedException will be thrown.</param>
/// <returns>The task object representing the asynchronous operation containing the <see name="SignInResult"/>
/// for the sign-in attempt.</returns>
public override async Task<SignInResult> PasswordSignInAsync(string userId, string password,
bool isPersistent, bool lockoutOnFailure)
{
if (lockoutOnFailure)
{
throw new NotSupportedException("Lockout is not enabled for the CognitoUserManager.");
}
var user = await _userManager.FindByIdAsync(userId).ConfigureAwait(false);
if (user == null)
{
return SignInResult.Failed;
}
return await PasswordSignInAsync(user, password, isPersistent, lockoutOnFailure).ConfigureAwait(false);
}
/// <summary>
/// Attempts to sign in the specified <paramref name="user"/> and <paramref name="password"/> combination
/// as an asynchronous operation.
/// </summary>
/// <param name="user">The user to sign in.</param>
/// <param name="password">The password to attempt to sign in with.</param>
/// <param name="isPersistent">Flag indicating whether the sign-in cookie should persist after the browser is closed.</param>
/// <param name="lockoutOnFailure">Cognito does not handle account lock out. This parameter must be set to false, or a NotSupportedException will be thrown.</param>
/// <returns>The task object representing the asynchronous operation containing the <see name="SignInResult"/>
/// for the sign-in attempt.</returns>
public override async Task<SignInResult> PasswordSignInAsync(TUser user, string password,
bool isPersistent, bool lockoutOnFailure)
{
if (lockoutOnFailure)
{
throw new NotSupportedException("Lockout is not enabled for the CognitoUserManager.");
}
if (user == null)
{
throw new ArgumentNullException(nameof(user));
}
var attempt = await CheckPasswordSignInAsync(user, password, lockoutOnFailure).ConfigureAwait(false);
if (attempt.Succeeded)
await SignInAsync(user, isPersistent).ConfigureAwait(false);
return attempt;
}
/// <summary>
/// Signs in the specified <paramref name="user"/>.
/// </summary>
/// <param name="user">The user to sign-in.</param>
/// <param name="isPersistent">Flag indicating whether the sign-in cookie should persist after the browser is closed.</param>
/// <param name="authenticationMethod">Name of the method used to authenticate the user.</param>
/// <returns>The task object representing the asynchronous operation.</returns>
public override Task SignInAsync(TUser user, bool isPersistent, string authenticationMethod = null)
{
// Populating the tokens to be retrieved when calling Context.GetTokenAsync(OpenIdConnectParameterNames.AccessToken).
var authenticationProperties = new AuthenticationProperties
{
IsPersistent = isPersistent,
AllowRefresh = true,
ExpiresUtc = user.SessionTokens?.ExpirationTime,
IssuedUtc = user.SessionTokens?.IssuedTime
};
AddUserTokensToAuthenticationProperties(user, authenticationProperties);
return SignInAsync(user, authenticationProperties, authenticationMethod);
}
/// <summary>
/// Adds a user tokens to the authentication properties
/// </summary>
/// <param name="user">The user to update tokens for</param>
/// <param name="authenticationProperties">The authentication properties to update</param>
private void AddUserTokensToAuthenticationProperties(TUser user, AuthenticationProperties authenticationProperties)
{
authenticationProperties.StoreTokens(new List<AuthenticationToken>()
{
new AuthenticationToken()
{
Name = OpenIdConnectParameterNames.AccessToken,
Value = user.SessionTokens?.AccessToken
},
new AuthenticationToken()
{
Name = OpenIdConnectParameterNames.RefreshToken,
Value = user.SessionTokens?.RefreshToken
},
new AuthenticationToken()
{
Name = OpenIdConnectParameterNames.IdToken,
Value = user.SessionTokens?.IdToken
}
});
}
/// <summary>
/// Regenerates the user's application cookie, whilst preserving the existing
/// AuthenticationProperties like rememberMe, as an asynchronous operation.
/// </summary>
/// <param name="user">The user whose sign-in cookie should be refreshed.</param>
/// <returns>The task object representing the asynchronous operation.</returns>
public override async Task RefreshSignInAsync(TUser user)
{
var result = await user.StartWithRefreshTokenAuthAsync(
new InitiateRefreshTokenAuthRequest()
{
AuthFlowType = AuthFlowType.REFRESH_TOKEN
}
).ConfigureAwait(false);
var auth = await Context.AuthenticateAsync(IdentityConstants.ApplicationScheme);
var authenticationMethod = auth?.Principal?.FindFirstValue(ClaimTypes.AuthenticationMethod);
var properties = auth?.Properties;
if (properties != null)
{
AddUserTokensToAuthenticationProperties(user, properties);
properties.ExpiresUtc = user.SessionTokens?.ExpirationTime;
properties.IssuedUtc = user.SessionTokens?.IssuedTime;
}
await SignInAsync(user, properties, authenticationMethod);
}
/// <summary>
/// Attempts a password sign in for a user.
/// </summary>
/// <param name="user">The user to sign in.</param>
/// <param name="password">The password to attempt to sign in with.</param>
/// <param name="lockoutOnFailure">Cognito does not handle account lock out. This parameter must be set to false, or a NotSupportedException will be thrown.</param>
/// <returns>The task object representing the asynchronous operation containing the <see name="SignInResult"/>
/// for the sign-in attempt.</returns>
public override async Task<SignInResult> CheckPasswordSignInAsync(TUser user, string password, bool lockoutOnFailure)
{
if (lockoutOnFailure)
{
throw new NotSupportedException("Lockout is not enabled for the CognitoUserManager.");
}
if (user == null)
{
throw new ArgumentNullException(nameof(user));
}
// Prechecks if the user password needs to be changed or reset
var error = await PreSignInCheck(user).ConfigureAwait(false);
if (error != null)
{
return error;
}
var checkPasswordResult = await _userManager.CheckPasswordAsync(user, password).ConfigureAwait(false);
SignInResult signinResult;
if (checkPasswordResult == null)
{
signinResult = SignInResult.Failed;
}
else if (checkPasswordResult.ChallengeName == ChallengeNameType.SMS_MFA ||
checkPasswordResult.ChallengeName == ChallengeNameType.SOFTWARE_TOKEN_MFA)
{
signinResult = SignInResult.TwoFactorRequired;
var userPrincipal = new ClaimsPrincipal();
userPrincipal.AddIdentity(new ClaimsIdentity(new List<Claim>() {
new Claim(ClaimTypes.Name, user.UserID),
new Claim(Cognito2FAAuthWorkflowKey, checkPasswordResult.SessionID),
new Claim(ClaimTypes.AuthenticationMethod, Cognito2FAProviderKey),
new Claim(Cognito2FAChallengeNameType, checkPasswordResult.ChallengeName),
}, IdentityConstants.ApplicationScheme));
// This signs in the user in the context of 2FA only.
await Context.SignInAsync(IdentityConstants.TwoFactorUserIdScheme, userPrincipal).ConfigureAwait(false);
}
else if (user.SessionTokens != null && user.SessionTokens.IsValid())
{
signinResult = SignInResult.Success;
}
else
{
signinResult = SignInResult.Failed;
}
return signinResult;
}
/// <summary>
/// Used to ensure that a user is allowed to sign in.
/// </summary>
/// <param name="user">The user</param>
/// <returns>Null if the user should be allowed to sign in, otherwise the SignInResult why they should be denied.</returns>
protected override async Task<SignInResult> PreSignInCheck(TUser user)
{
// Checks for email/phone number confirmation status
if (!await CanSignInAsync(user).ConfigureAwait(false))
{
return SignInResult.NotAllowed;
}
if (await IsPasswordChangeRequiredAsync(user).ConfigureAwait(false))
{
return CognitoSignInResult.PasswordChangeRequired;
}
if (await IsPasswordResetRequiredAsync(user).ConfigureAwait(false))
{
return CognitoSignInResult.PasswordResetRequired;
}
return null;
}
/// <summary>
/// Checks if the password needs to be changed for the specified <paramref name="user"/>.
/// </summary>
/// <param name="user">The user to check if the password needs to be changed.</param>
/// <returns>The <see cref="Task"/> that represents the asynchronous operation, containing a boolean set to true if the password needs to be changed, false otherwise.</returns>
protected Task<bool> IsPasswordChangeRequiredAsync(TUser user)
{
return _userManager.IsPasswordChangeRequiredAsync(user);
}
/// <summary>
/// Checks if the password needs to be reset for the specified <paramref name="user"/>.
/// </summary>
/// <param name="user">The user to check if the password needs to be reset.</param>
/// <returns>The <see cref="Task"/> that represents the asynchronous operation, containing a boolean set to true if the password needs to be reset, false otherwise.</returns>
protected Task<bool> IsPasswordResetRequiredAsync(TUser user)
{
return _userManager.IsPasswordResetRequiredAsync(user);
}
/// <summary>
/// Validates the two factor sign in code and creates and signs in the user, as an asynchronous operation.
/// </summary>
/// <param name="code">The two factor authentication code to validate.</param>
/// <param name="isPersistent">Flag indicating whether the sign-in cookie should persist after the browser is closed.</param>
/// <param name="rememberClient">Flag indicating whether the current browser should be remember, suppressing all further
/// two factor authentication prompts.</param>
/// <returns>The task object representing the asynchronous operation containing the <see name="SignInResult"/>
/// for the sign-in attempt.</returns>
public async Task<SignInResult> RespondToTwoFactorChallengeAsync(string code, bool isPersistent, bool rememberClient)
{
var twoFactorInfo = await RetrieveTwoFactorInfoAsync().ConfigureAwait(false);
if (twoFactorInfo == null || string.IsNullOrWhiteSpace(twoFactorInfo.UserId))
{
return SignInResult.Failed;
}
var user = await _userManager.FindByIdAsync(twoFactorInfo.UserId).ConfigureAwait(false);
if (user == null)
{
return SignInResult.Failed;
}
// Responding to the Cognito challenge.
await _userManager.RespondToTwoFactorChallengeAsync(user, code, twoFactorInfo.ChallengeNameType, twoFactorInfo.CognitoAuthenticationWorkflowId).ConfigureAwait(false);
if (user.SessionTokens == null || !user.SessionTokens.IsValid())
{
return SignInResult.Failed;
}
else
{
// Cleanup external cookie
if (twoFactorInfo.LoginProvider != null)
{
await Context.SignOutAsync(IdentityConstants.ExternalScheme).ConfigureAwait(false);
}
// Cleanup two factor user id cookie
await Context.SignOutAsync(IdentityConstants.TwoFactorUserIdScheme).ConfigureAwait(false);
if (rememberClient)
{
await RememberTwoFactorClientAsync(user).ConfigureAwait(false);
}
// This creates the ClaimPrincipal and signs in the user in the IdentityConstants.ApplicationScheme
await SignInAsync(user, isPersistent, twoFactorInfo.LoginProvider).ConfigureAwait(false);
return SignInResult.Success;
}
}
/// <summary>
/// Gets the <typeparamref name="TUser"/> for the current two factor authentication login, as an asynchronous operation.
/// </summary>
/// <returns>The task object representing the asynchronous operation containing the <typeparamref name="TUser"/>
/// for the sign-in attempt.</returns>
public override async Task<TUser> GetTwoFactorAuthenticationUserAsync()
{
var info = await RetrieveTwoFactorInfoAsync().ConfigureAwait(false);
if (info == null)
{
return null;
}
return await UserManager.FindByIdAsync(info.UserId).ConfigureAwait(false);
}
#region 2FA
/// <summary>
/// Retrieves the information related to the authentication workflow.
/// </summary>
/// <returns></returns>
private async Task<TwoFactorAuthenticationInfo> RetrieveTwoFactorInfoAsync()
{
var result = await Context.AuthenticateAsync(IdentityConstants.TwoFactorUserIdScheme).ConfigureAwait(false);
if (result?.Principal != null)
{
return new TwoFactorAuthenticationInfo
{
UserId = result.Principal.FindFirstValue(ClaimTypes.Name),
LoginProvider = result.Principal.FindFirstValue(ClaimTypes.AuthenticationMethod),
CognitoAuthenticationWorkflowId = result.Principal.FindFirstValue(Cognito2FAAuthWorkflowKey),
ChallengeNameType = result.Principal.FindFirstValue(Cognito2FAChallengeNameType)
};
}
return null;
}
/// <summary>
/// Utility class to model information related to the ongoing authentication workflow.
/// </summary>
internal class TwoFactorAuthenticationInfo
{
public string UserId { get; set; }
public string LoginProvider { get; set; }
public string CognitoAuthenticationWorkflowId { get; set; }
public ChallengeNameType ChallengeNameType { get; set; }
}
#endregion
/// <summary>
/// Validates the security stamp for the specified <paramref name="user"/>. Will always return false
/// if the userManager does not support security stamps.
/// </summary>
/// <param name="user">The user whose stamp should be validated.</param>
/// <param name="securityStamp">The expected security stamp value.</param>
/// <returns>True if the stamp matches the persisted value, otherwise it will return false.</returns>
public override async Task<bool> ValidateSecurityStampAsync(TUser user, string securityStamp)
=> user != null &&
// Only validate the security stamp if the store supports it
(!UserManager.SupportsUserSecurityStamp || securityStamp == await UserManager.GetSecurityStampAsync(user).ConfigureAwait(false));
// Preventing the cookies from expiring every 30 minutes. This fix was only added to Identity 2.2.
// https://github.com/aspnet/Identity/pull/1941
}
}
| 454 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Microsoft.AspNetCore.Identity;
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoSignInResult : SignInResult
{
/// <summary>
/// Returns a CognitoSignInResult that represents a required password change.
/// </summary>
/// <returns>A CognitoSignInResult that represents a required password change.</returns>
public static readonly CognitoSignInResult PasswordChangeRequired = new CognitoSignInResult { RequiresPasswordChange = true };
/// <summary>
/// Returns a CognitoSignInResult that represents a required password reset.
/// </summary>
/// <returns>A CognitoSignInResult that represents a required password reset.</returns>
public static readonly CognitoSignInResult PasswordResetRequired = new CognitoSignInResult { RequiresPasswordReset = true };
/// <summary>
/// Returns a flag indication whether changing the password is required.
/// </summary>
/// <returns>A flag indication whether changing the password is required.</returns>
public bool RequiresPasswordChange { get; protected set; }
/// <summary>
/// Returns a flag indication whether reseting the password is required.
/// </summary>
/// <returns>A flag indication whether reseting the password is required.</returns>
public bool RequiresPasswordReset { get; protected set; }
/// <summary>
/// Converts the value of the current <see cref="CognitoSignInResult"/> object to its equivalent string representation.
/// </summary>
/// <returns>A string representation of value of the current <see cref="CognitoSignInResult"/> object.</returns>
public override string ToString()
{
return IsLockedOut ? "Lockedout" :
IsNotAllowed ? "NotAllowed" :
RequiresTwoFactor ? "RequiresTwoFactor" :
RequiresPasswordChange ? "RequiresPasswordChange" :
RequiresPasswordReset ? "RequiresPasswordReset" :
Succeeded ? "Succeeded" : "Failed";
}
}
public static class SigninResultExtensions
{
public static bool IsCognitoSignInResult(this SignInResult result)
{
return result is CognitoSignInResult;
}
}
}
| 69 |
aws-aspnet-cognito-identity-provider | aws | C# | /*
* Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
using Amazon.Extensions.CognitoAuthentication;
using Microsoft.AspNetCore.Identity;
using Microsoft.Extensions.Options;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Claims;
using System.Threading.Tasks;
namespace Amazon.AspNetCore.Identity.Cognito
{
public class CognitoUserClaimsPrincipalFactory<TUser> : IUserClaimsPrincipalFactory<TUser> where TUser : CognitoUser
{
private readonly CognitoUserManager<TUser> _userManager;
private readonly IdentityOptions _identityOptions;
private readonly Dictionary<string, CognitoAttribute> claimToAttributesMapping = new Dictionary<string, CognitoAttribute>()
{
{ ClaimTypes.Email, CognitoAttribute.Email },
{ ClaimTypes.DateOfBirth, CognitoAttribute.BirthDate },
{ ClaimTypes.Surname, CognitoAttribute.FamilyName },
{ ClaimTypes.Gender, CognitoAttribute.Gender },
{ ClaimTypes.GivenName, CognitoAttribute.GivenName },
{ ClaimTypes.Name, CognitoAttribute.Name },
{ ClaimTypes.MobilePhone, CognitoAttribute.PhoneNumber },
{ ClaimTypes.Webpage, CognitoAttribute.Website }
};
public CognitoUserClaimsPrincipalFactory(UserManager<TUser> userManager, IOptions<IdentityOptions> optionsAccessor)
{
_userManager = userManager as CognitoUserManager<TUser>;
if (_userManager == null)
throw new ArgumentNullException("The userManager must be of type CognitoUserManager<TUser>", nameof(userManager));
if (optionsAccessor?.Value == null)
{
throw new ArgumentNullException(nameof(optionsAccessor));
}
_identityOptions = optionsAccessor.Value;
}
public async Task<ClaimsPrincipal> CreateAsync(TUser user)
{
var claims = await _userManager.GetClaimsAsync(user).ConfigureAwait(false) as List<Claim>;
claimToAttributesMapping.ToList().ForEach(claim => MapClaimTypesToCognito(claims, claim.Key, claim.Value.AttributeName));
claims.Add(new Claim(_identityOptions.ClaimsIdentity.UserNameClaimType, user.Username));
claims.Add(new Claim(_identityOptions.ClaimsIdentity.UserIdClaimType, user.Username));
var roles = await _userManager.GetRolesAsync(user).ConfigureAwait(false);
var roleClaimType = _identityOptions.ClaimsIdentity.RoleClaimType;
// Roles are claims with a specific schema uri
roles.ToList().ForEach(role => claims.Add(new Claim(roleClaimType, role)));
var claimsIdentity = new ClaimsIdentity(claims, IdentityConstants.ApplicationScheme, _identityOptions.ClaimsIdentity.UserNameClaimType, roleClaimType);
return new ClaimsPrincipal(claimsIdentity);
}
/// <summary>
/// Internal method to map System.Security.Claims.ClaimTypes to Cognito Standard Attributes
/// </summary>
/// <param name="claims"></param>
private void MapClaimTypesToCognito(List<Claim> claims, string claimType, string cognitoAttribute)
{
var claim = claims.FirstOrDefault(c => c.Type == cognitoAttribute);
if (claim != null)
claims.Add(new Claim(claimType, claim.Value));
}
}
}
| 89 |
Subsets and Splits