CngKeyBlobFormat Class

 

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

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

System.Object
  System.Security.Cryptography.CngKeyBlobFormat

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

NameDescription
System_CAPS_pubmethodCngKeyBlobFormat(String)

Initializes a new instance of the CngKeyBlobFormat class by using the specified format.

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticEccPrivateBlob

Gets a CngKeyBlobFormat object that specifies a private key BLOB for an elliptic curve cryptography (ECC) key.

System_CAPS_pubpropertySystem_CAPS_staticEccPublicBlob

Gets a CngKeyBlobFormat object that specifies a public key BLOB for an elliptic curve cryptography (ECC) key.

System_CAPS_pubpropertyFormat

Gets the name of the key BLOB format that the current CngKeyBlobFormat object specifies.

System_CAPS_pubpropertySystem_CAPS_staticGenericPrivateBlob

Gets a CngKeyBlobFormat object that specifies a generic private key BLOB.

System_CAPS_pubpropertySystem_CAPS_staticGenericPublicBlob

Gets a CngKeyBlobFormat object that specifies a generic public key BLOB.

System_CAPS_pubpropertySystem_CAPS_staticOpaqueTransportBlob

Gets a CngKeyBlobFormat object that specifies an opaque transport key BLOB.

System_CAPS_pubpropertySystem_CAPS_staticPkcs8PrivateBlob

Gets a CngKeyBlobFormat object that specifies a Private Key Information Syntax Standard (PKCS #8) key BLOB.

NameDescription
System_CAPS_pubmethodEquals(CngKeyBlobFormat)

Compares the specified CngKeyBlobFormat object to the current CngKeyBlobFormat object.

System_CAPS_pubmethodEquals(Object)

Compares the specified object to the current CngKeyBlobFormat object.(Overrides Object.Equals(Object).)

System_CAPS_pubmethodGetHashCode()

Generates a hash value for the embedded key BLOB format in the current CngKeyBlobFormat object.(Overrides Object.GetHashCode().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Gets the name of the key BLOB format that the current CngKeyBlobFormat object specifies.(Overrides Object.ToString().)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticEquality(CngKeyBlobFormat, CngKeyBlobFormat)

Determines whether two CngKeyBlobFormat objects specify the same key BLOB format.

System_CAPS_puboperatorSystem_CAPS_staticInequality(CngKeyBlobFormat, CngKeyBlobFormat)

Determines whether two CngKeyBlobFormat objects do not specify the same key BLOB format.

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.

.NET Framework
Available since 3.5

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: