awsdotnet/AWS.Cryptography.EncryptionSDKv4.0.0
✓ Verified.NET FW4.8.NET 6.0
The AWS Encryption SDK is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices.
Get Started
$ dotnet add package AWS.Cryptography.EncryptionSDKReadme
AWS Encryption SDK for .NET
AWS Encryption SDK for .NET
Using the AWS Encryption SDK for .NET
The AWS Encryption SDK is available on NuGet and can referenced from an existing .csproj through typical ways.
Using the dotnet CLI:
dotnet add <your-project-name>.csproj package AWS.Cryptography.EncryptionSDK
Alternatively, you may directly modify the .csproj and add the AWS Encryption SDK to PackageReference ItemGroup:
<PackageReference Include="AWS.Cryptography.EncryptionSDK" />
The AWS Encryption SDK targets .NET 6.0 and newer on all platforms, and .NET Framework 4.8.0 and newer on Windows only.
Additional setup for macOS only
If you are using macOS then you must install OpenSSL 1.1,
and the OpenSSL 1.1 lib directory must be on the dynamic linker path at runtime.
Also, if using an M1-based Mac, you must install OpenSSL and the .NET SDK for x86-64.
Please refer to the wiki for detailed instructions.
Building the AWS Encryption SDK for .NET
To build, the AWS Encryption SDK requires the most up to date version of Dafny on your PATH.
The AWS Encryption SDK targets frameworks net48.
Tests and test vectors target frameworks net6.0.
In all cases, net48 and newer .NET Framework versions are only supported on Windows.
To build and test the AWS Encryption SDK, you must install the following .NET tools:
- .NET 6.0 or newer
- .NET Framework 4.8.0 or newer (if on Windows)