System.Security.Cryptography.ProtectedData 8.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package System.Security.Cryptography.ProtectedData --version 8.0.0
NuGet\Install-Package System.Security.Cryptography.ProtectedData -Version 8.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="System.Security.Cryptography.ProtectedData" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add System.Security.Cryptography.ProtectedData --version 8.0.0
#r "nuget: System.Security.Cryptography.ProtectedData, 8.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 System.Security.Cryptography.ProtectedData as a Cake Addin
#addin nuget:?package=System.Security.Cryptography.ProtectedData&version=8.0.0

// Install System.Security.Cryptography.ProtectedData as a Cake Tool
#tool nuget:?package=System.Security.Cryptography.ProtectedData&version=8.0.0

About

System.Security.Cryptography.ProtectedData offers a simplified interface for utilizing Microsoft Windows DPAPI's CryptProtectData and CryptUnprotectData functions.

Note: Since it relies on Windows DPAPI, this package is only supported on Windows platforms. For more complex cryptographic operations or cross-platform support, consider the System.Security.Cryptography namespace.

Key Features

  • Built upon the robust and secure Windows Data Protection API (DPAPI).
  • Data can be protected either for current process or for any process on the machine.
  • Scope of protection can be defined either to the current user or the local machine.

How to Use

Utilizing this package is quite simple, and it mainly revolves around two methods: Protect and Unprotect.

Here, originalData is the data you want to protect, optionalEntropy is an additional byte array used to increase encryption complexity, and DataProtectionScope specifies whether the data protection should apply to the current user or the machine.

using System.Security.Cryptography;
using System.Text;

byte[] originalData = Encoding.UTF8.GetBytes("This is a secret");
byte[] optionalEntropy = new byte[64];
Random.Shared.NextBytes(optionalEntropy);

// To protect:
byte[] encryptedData = ProtectedData.Protect(
    originalData,
    optionalEntropy,
    DataProtectionScope.CurrentUser);

// To unprotect:
byte[] decryptedData = ProtectedData.Unprotect(
    encryptedData,
    optionalEntropy,
    DataProtectionScope.CurrentUser);

Main Types

The main type provided by this library is:

  • System.Security.Cryptography.ProtectedData

Additional Documentation

Feedback & Contributing

System.Security.Cryptography.ProtectedData is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

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 is compatible.  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 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed.  monoandroid10 is compatible. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed.  monotouch10 is compatible. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed.  xamarinios10 is compatible. 
Xamarin.Mac xamarinmac was computed.  xamarinmac20 is compatible. 
Xamarin.TVOS xamarintvos was computed.  xamarintvos10 is compatible. 
Xamarin.WatchOS xamarinwatchos was computed.  xamarinwatchos10 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.6.2

    • No dependencies.
  • .NETStandard 2.0

  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (197)

Showing the top 5 NuGet packages that depend on System.Security.Cryptography.ProtectedData:

Package Downloads
System.Configuration.ConfigurationManager The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides types that support using XML configuration files (app.config). This package exists only to support migrating existing .NET Framework code that already uses System.Configuration. When writing new code, use another configuration system instead, such as Microsoft.Extensions.Configuration.

Azure.Identity The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This is the implementation of the Azure SDK Client Library for Azure Identity

Microsoft.Identity.Client.Extensions.Msal The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This package contains the public client (desktop) caching to Microsoft Authentication Library for .NET (MSAL.NET)

NuGet.Configuration The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

NuGet's configuration settings implementation.

Microsoft.Windows.Compatibility The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

This Windows Compatibility Pack provides access to APIs that were previously available only for .NET Framework. It can be used from both .NET as well as .NET Standard.

GitHub repositories (59)

Showing the top 5 popular GitHub repositories that depend on System.Security.Cryptography.ProtectedData:

Repository Stars
BeyondDimension/SteamTools
🛠「Watt Toolkit」是一个开源跨平台的多功能 Steam 工具箱。
rocksdanister/lively
Free and open-source software that allows users to set animated desktop wallpapers and screensavers powered by WinUI 3.
Jackett/Jackett
API Support for your favorite torrent trackers
JustArchiNET/ArchiSteamFarm
C# application with primary purpose of farming Steam cards from multiple accounts simultaneously.
mRemoteNG/mRemoteNG
mRemoteNG is the next generation of mRemote, open source, tabbed, multi-protocol, remote connections manager.
Version Downloads Last updated
9.0.0-preview.5.24306.7 2,384 6/11/2024
9.0.0-preview.4.24266.19 5,936 5/21/2024
9.0.0-preview.3.24172.9 10,991 4/11/2024
9.0.0-preview.2.24128.5 12,061 3/12/2024
9.0.0-preview.1.24080.9 17,958 2/13/2024
8.0.0 19,630,786 11/14/2023
8.0.0-rc.2.23479.6 129,770 10/10/2023
8.0.0-rc.1.23419.4 105,826 9/12/2023
8.0.0-preview.7.23375.6 46,795 8/8/2023
8.0.0-preview.6.23329.7 23,379 7/11/2023
8.0.0-preview.5.23280.8 25,253 6/13/2023
8.0.0-preview.4.23259.5 58,746 5/16/2023
8.0.0-preview.3.23174.8 66,121 4/11/2023
8.0.0-preview.2.23128.3 37,737 3/14/2023
8.0.0-preview.1.23110.8 38,238 2/21/2023
7.0.1 6,785,817 2/14/2023
7.0.0 40,909,513 11/7/2022
7.0.0-rc.2.22472.3 134,729 10/11/2022
7.0.0-rc.1.22426.10 130,074 9/14/2022
7.0.0-preview.7.22375.6 31,788 8/9/2022
7.0.0-preview.6.22324.4 34,194 7/12/2022
7.0.0-preview.5.22301.12 39,211 6/14/2022
7.0.0-preview.4.22229.4 29,840 5/10/2022
7.0.0-preview.3.22175.4 11,634 4/13/2022
7.0.0-preview.2.22152.2 24,661 3/14/2022
7.0.0-preview.1.22076.8 22,366 2/17/2022
6.0.2-mauipre.1.22102.15 13,366 2/15/2022
6.0.2-mauipre.1.22054.8 55,841 1/19/2022
6.0.0 221,745,067 11/8/2021
6.0.0-rc.2.21480.5 51,879 10/12/2021
6.0.0-rc.1.21451.13 70,261 9/14/2021
6.0.0-preview.7.21377.19 60,086 8/10/2021
6.0.0-preview.6.21352.12 49,694 7/14/2021
6.0.0-preview.5.21301.5 42,099 6/15/2021
6.0.0-preview.4.21253.7 62,790 5/24/2021
6.0.0-preview.3.21201.4 151,364 4/8/2021
6.0.0-preview.2.21154.6 64,494 3/11/2021
6.0.0-preview.1.21102.12 105,802 2/12/2021
5.0.0 264,346,978 11/9/2020
5.0.0-rc.2.20475.5 80,284 10/13/2020
5.0.0-rc.1.20451.14 54,492 9/14/2020
5.0.0-preview.8.20407.11 154,767 8/25/2020
5.0.0-preview.7.20364.11 101,455 7/21/2020
5.0.0-preview.6.20305.6 233,779 6/25/2020
5.0.0-preview.5.20278.1 21,744 6/10/2020
5.0.0-preview.4.20251.6 94,623 5/18/2020
5.0.0-preview.3.20214.6 61,036 4/23/2020
5.0.0-preview.2.20160.6 73,424 4/2/2020
5.0.0-preview.1.20120.5 54,187 3/16/2020
4.7.0 538,560,169 12/3/2019
4.7.0-preview3.19551.4 61,044 11/13/2019
4.7.0-preview2.19523.17 21,682 11/1/2019
4.7.0-preview1.19504.10 25,465 10/15/2019
4.6.0 46,408,805 9/23/2019
4.6.0-rc1.19456.4 65,221 9/16/2019
4.6.0-preview9.19421.4 24,487 9/4/2019
4.6.0-preview9.19416.11 693 9/4/2019
4.6.0-preview8.19405.3 88,967 8/13/2019
4.6.0-preview7.19362.9 195,569 7/23/2019
4.6.0-preview6.19303.8 740,328 6/12/2019
4.6.0-preview6.19264.9 763 9/4/2019
4.6.0-preview5.19224.8 57,699 5/6/2019
4.6.0-preview4.19212.13 14,511 4/18/2019
4.6.0-preview3.19128.7 70,257 3/6/2019
4.6.0-preview.19073.11 56,571 1/29/2019
4.6.0-preview.18571.3 123,826 12/3/2018
4.5.0 519,621,402 5/29/2018
4.5.0-rc1 138,610 5/6/2018
4.5.0-preview2-26406-04 447,118 4/10/2018
4.5.0-preview1-26216-02 426,056 2/26/2018
4.5.0-preview1-25914-04 636,742 11/15/2017
4.4.0 381,218,432 8/11/2017
4.4.0-preview2-25405-01 69,191 6/27/2017
4.4.0-preview1-25305-02 10,824 5/9/2017
4.3.0 18,321,248 11/15/2016
4.3.0-preview1-24530-04 28,751 10/24/2016
4.0.0 2,895,827 6/27/2016