Microsoft.Data.Encryption.Cryptography 1.0.0

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Microsoft.Data.Encryption.Cryptography --version 1.0.0                

                    
                

            
NuGet\Install-Package Microsoft.Data.Encryption.Cryptography -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.Data.Encryption.Cryptography" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Microsoft.Data.Encryption.Cryptography --version 1.0.0                

                    
                

            
#r "nuget: Microsoft.Data.Encryption.Cryptography, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Microsoft.Data.Encryption.Cryptography as a Cake Addin
#addin nuget:?package=Microsoft.Data.Encryption.Cryptography&version=1.0.0

// Install Microsoft.Data.Encryption.Cryptography as a Cake Tool
#tool nuget:?package=Microsoft.Data.Encryption.Cryptography&version=1.0.0

GitHub license Nuget

Overview

Microsoft.Data.Encryption.Cryptography provides encryption support to applications. It allows developers to implement column- or field-level encryption for data stored in various data stores, including Azure data services.

This release (v1.0.0) is the first stable release of the library.

Features

The library provides APIs for objects like encryption keys, serializers, key store provider interfaces, and associated caches.

The module implements cryptographic operations using a two-level key hierarchy composed of:

  • Data Encryption Keys (DEKs) - symmetric keys that encrypt data.
  • Key Encryption Keys (KEKs) - asymmetric keys that encrypt DEKs.

The Cryptography module uses cryptographic algorithms that are fully compatible with Always Encrypted in Azure SQL. The data encryption algorithm is AEAD_AES_256_CBC_HMAC_SHA_256 that is derived from the IETF specification draft at https://tools.ietf.org/html/draft-mcgrew-aead-aes-cbc-hmac-sha2-05. The key encryption algorithm is RSA with OEAP padding. For more information, see Always Encrypted cryptography.

Using the SDK for data protection in Azure

The below diagram shows an example of an Azure application and illustrates the benefits of the Microsoft Data Encryption SDK.

Microsoft Encryption SDK Overview Diagram

In such applications, the SDK helps ensure:

  • Interoperability with Always Encrypted in Azure SQL
    • You can load the data, encrypted using the SDK, to databases columns configured with Always Encrypted in Azure SQL.
    • If you ensure the database columns are encrypted in the same way as the data you are inserting, your Azure Data Factory and Spark jobs as well as your applications can transparently decrypt the data stored in the database and run confidential queries using Azure SQL client drivers. This is because the SDK is compatible with Always Encrypted.
    • Similarly, you can move the data from a database in Azure SQL to another service or application without decrypting it. Then, you can use the SDK to decrypt the data where it needs to be decrypted, rather than in an application that directly talks to the database.

Supported Platforms

The SDK currently supports the following platforms:

  • .NET Standard 2.0 or higher

Installation

To install the latest version of Microsoft.Data.Encryption.Cryptography via NuGet, use the following command:

dotnet add package Microsoft.Data.Encryption.Cryptography --version 1.0.0

Changes from 0.2.0-prerelease

  • Significant performance and memory optimizations while sustaining current API.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Microsoft.Data.Encryption.Cryptography:

Package Downloads
Microsoft.Data.Encryption.AzureKeyVaultProvider

The Microsoft Data Encryption SDK provides encryption support to applications. The Microsoft.Data.Encryption.AzureKeyVaultProvider enables .NET applications to use Microsoft Azure Key Vault to perform encryption/decryption. Commonly Used Types: Microsoft.Data.Encryption.AzureKeyVaultProvider.AzureKeyVaultKeyStoreProvider When using NuGet 3.x this package requires at least version 3.4.
Microsoft.Azure.Cosmos.Encryption.Custom

This is an internal library that provides an implementation for client-side encryption for Azure Cosmos DB for NoSQL for multi-tenant use case. For more information, refer to https://aka.ms/CosmosCustomClientEncryption
Microsoft.Data.Encryption.FileEncryption

The Microsoft Data Encryption SDK provides encryption support to applications. The Microsoft.Data.Encryption.FileEncryption package provides parquet file encryption support. Commonly Used Types: Microsoft.Data.Encryption.FileEncryption.IColumn Microsoft.Data.Encryption.FileEncryption.IColumnarDataReader Microsoft.Data.Encryption.FileEncryption.IColumnarDataWriter Microsoft.Data.Encryption.FileEncryption.Column Microsoft.Data.Encryption.FileEncryption.ColumnarCryptographer Microsoft.Data.Encryption.FileEncryption.CryptoMetadata Microsoft.Data.Encryption.FileEncryption.ParquetFileReader Microsoft.Data.Encryption.FileEncryption.ParquetFileWriter Microsoft.Data.Encryption.FileEncryption.FileEncryptionSettings When using NuGet 3.x this package requires at least version 3.4.
Xtrimmer.KeyStoreProvider.Certificate

The implementation of the Microsoft.Data.Encryption.Cryptography.EncryptionKeyStoreProvider for Windows Certificate Store. This package enables using certificates stored in the Windows Certificate Store as key encryption keys.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Data.Encryption.Cryptography:

Repository Stars
Azure/azure-cosmos-dotnet-v3
.NET SDK for Azure Cosmos DB for the core SQL API
Version Downloads Last updated
2.0.0-pre007 1,845 10/1/2024
1.2.0 2,476 9/24/2024
1.1.0 146 9/11/2024
1.0.0 139 9/5/2024
0.2.0-pre 139,376 3/26/2021
0.1.0-pre 7,962 1/6/2021