Export (0) Print
Expand All

CngKeyBlobFormat Class

Specifies a key BLOB format for use with Microsoft Cryptography Next Generation (CNG) objects.

System.Object
  System.Security.Cryptography.CngKeyBlobFormat

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

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

The CngKeyBlobFormat type exposes the following members.

  NameDescription
Public methodCngKeyBlobFormatInitializes a new instance of the CngKeyBlobFormat class by using the specified format.
Top

  NameDescription
Public propertyStatic memberEccPrivateBlobGets a CngKeyBlobFormat object that specifies a private key BLOB for an elliptic curve cryptography (ECC) key.
Public propertyStatic memberEccPublicBlobGets a CngKeyBlobFormat object that specifies a public key BLOB for an elliptic curve cryptography (ECC) key.
Public propertyFormatGets the name of the key BLOB format that the current CngKeyBlobFormat object specifies.
Public propertyStatic memberGenericPrivateBlobGets a CngKeyBlobFormat object that specifies a generic private key BLOB.
Public propertyStatic memberGenericPublicBlobGets a CngKeyBlobFormat object that specifies a generic public key BLOB.
Public propertyStatic memberOpaqueTransportBlobGets a CngKeyBlobFormat object that specifies an opaque transport key BLOB.
Public propertyStatic memberPkcs8PrivateBlobGets a CngKeyBlobFormat object that specifies a Private Key Information Syntax Standard (PKCS #8) key BLOB.
Top

  NameDescription
Public methodEquals(CngKeyBlobFormat)Compares the specified CngKeyBlobFormat object to the current CngKeyBlobFormat object.
Public methodEquals(Object)Compares the specified object to the current CngKeyBlobFormat object. (Overrides Object.Equals(Object).)
Public methodGetHashCodeGenerates a hash value for the embedded key BLOB format in the current CngKeyBlobFormat object. (Overrides Object.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringGets the name of the key BLOB format that the current CngKeyBlobFormat object specifies. (Overrides Object.ToString().)
Top

  NameDescription
Public operatorStatic memberEqualityDetermines whether two CngKeyBlobFormat objects specify the same key BLOB format.
Public operatorStatic memberInequalityDetermines whether two CngKeyBlobFormat objects do not specify the same key BLOB format.
Top

The CngKeyBlobFormat class is a utility class. It consists of static properties, comparison methods, and a private, internally maintained string that specifies the key BLOB format name.

The static properties return CngKeyBlobFormat objects. Each object's internal string name is initialized to the key BLOB format name that corresponds to the name of the static property.

You can also use this class to create objects for key BLOB formats that are not covered by the static properties.

Several CNG classes (such as CngKey) accept CngKeyBlobFormat objects through a format parameter. When the class receives the CngKeyBlobFormat object, it retrieves the embedded name of the key BLOB format by calling the object's Format property.

Therefore, CngKeyBlobFormat serves as an enumeration of well-known key BLOB formats. It lets you identify a well-known key BLOB format by using a strongly typed value instead of a string.

NoteNote

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.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft