This documentation is archived and is not being maintained.

CngProvider Class

Encapsulates the name of a key storage provider (KSP) for use with Cryptography Next Generation (CNG) objects.


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

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class CngProvider : IEquatable<CngProvider>

The CngProvider type exposes the following members.

Public methodCngProviderInitializes a new instance of the CngProvider class.

Public propertyStatic memberMicrosoftSmartCardKeyStorageProviderGets a CngProvider object that specifies the Microsoft Smart Card Key Storage Provider.
Public propertyStatic memberMicrosoftSoftwareKeyStorageProviderGets a CngProvider object that specifies the Microsoft Software Key Storage Provider.
Public propertyProviderGets the name of the key storage provider (KSP) that the current CngProvider object specifies.

Public methodEquals(CngProvider)Compares the specified CngProvider object to the current CngProvider object.
Public methodEquals(Object)Compares the specified object to the current CngProvider object. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeGenerates a hash value for the name of the key storage provider (KSP) that is embedded in the current CngProvider object. (Overrides Object.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringGets the name of the key storage provider (KSP) that the current CngProvider object specifies. (Overrides Object.ToString().)

Public operatorStatic memberEqualityDetermines whether two CngProvider objects specify the same key storage provider (KSP).
Public operatorStatic memberInequalityDetermines whether two CngProvider objects do not represent the same key storage provider (KSP).

The CngProvider class is a utility class. It consists of static properties, comparison methods, and a private, internally maintained string that specifies a key storage provider.

The static properties return CngProvider objects. Each object's internal string is initialized to the provider name that corresponds to the name of the static property.

You can also use this class to create objects for provider types that are not covered by the static properties.

Several CNG classes (such as CngKey) accept CngProvider objects through a provider parameter. When the class receives the CngProvider object, it retrieves the embedded provider name by calling the object's Provider property.

Therefore, CngProvider serves as an enumeration of well-known providers. It lets you identify a provider by using a strongly typed value instead of a string.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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