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.
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 and net6.0.
To build and test the AWS Encryption SDK, you must install the following .NET tools:
You will also need to ensure that you fetch all submodules using either git clone --recursive ... when cloning the repository or git submodule update --init on an existing clone.
To build all source files into one dll:
# Transpile Dafny to .NET
cd AwsEncryptionSDK
make transpile_implementation_net
# Run dotnet restore
make setup_net
# Run dotnet build
dotnet build runtimes/net
(Optional) Set up the AWS Encryption SDK to work with AWS KMS
If you set up the AWS Encryption SDK to use the AWS KMS Keyring,
the AWS Encryption SDK will make calls to AWS KMS on your behalf,
using the appropriate AWS SDK.
However, you must first set up AWS credentials for use with the AWS SDK.
Instructions for setting up AWS credentials are available in the AWS Docs for the AWS SDK for .NET..
Testing the AWS Encryption SDK for .NET
Configure AWS credentials
To run the test suite you must first set up AWS credentials for use with the AWS SDK.
This is required in order to run the integration tests, which use a KMS Keyring against a publicly accessible KMS CMK.