ProtectedMemory Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Provides methods for protecting and unprotecting memory. This class cannot be inherited.

Namespace:   System.Security.Cryptography
Assembly:  System.Security (in System.Security.dll)

System.Object
  System.Security.Cryptography.ProtectedMemory

<HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort := True)>
Public NotInheritable Class ProtectedMemory

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticProtect(Byte(), MemoryProtectionScope)

Protects the specified data.

System_CAPS_pubmethodSystem_CAPS_staticUnprotect(Byte(), MemoryProtectionScope)

Unprotects data in memory that was protected using the Protect method.

This class provides access to the Data Protection API (DPAPI) available in the Windows XP and later operating systems. This is a service that is provided by the operating system and does not require additional libraries. It provides encryption for sensitive data in memory.

The class consists of two wrappers for the unmanaged DPAPI, Protect and Unprotect. These two methods can be used to encrypt and decrypt data in memory.

The following example shows how to use data protection.

Imports System
Imports System.Security.Cryptography



Public Class MemoryProtectionSample

    Public Shared Sub Main()
        ' Create the original data to be encrypted (The data length should be a multiple of 16).
        Dim secret As Byte() = {1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4}

        ' Encrypt the data in memory. The result is stored in the same same array as the original data.
        ProtectedMemory.Protect(secret, MemoryProtectionScope.SameLogon)

        ' Decrypt the data in memory and store in the original array.
        ProtectedMemory.Unprotect(secret, MemoryProtectionScope.SameLogon)

    End Sub
End Class

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: