CngAlgorithm Class
TOC
Collapse the table of content
Expand the table of content

CngAlgorithm Class

 

Encapsulates the name of an encryption algorithm.

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

System.Object
  System.Security.Cryptography.CngAlgorithm

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

NameDescription
System_CAPS_pubmethodCngAlgorithm(String)

Initializes a new instance of the CngAlgorithm class.

NameDescription
System_CAPS_pubpropertyAlgorithm

Gets the algorithm name that the current CngAlgorithm object specifies.

System_CAPS_pubpropertySystem_CAPS_staticECDiffieHellmanP256

Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-256 curve.

System_CAPS_pubpropertySystem_CAPS_staticECDiffieHellmanP384

Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-384 curve.

System_CAPS_pubpropertySystem_CAPS_staticECDiffieHellmanP521

Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-521 curve.

System_CAPS_pubpropertySystem_CAPS_staticECDsaP256

Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-256 curve.

System_CAPS_pubpropertySystem_CAPS_staticECDsaP384

Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-384 curve.

System_CAPS_pubpropertySystem_CAPS_staticECDsaP521

Gets a new CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-521 curve.

System_CAPS_pubpropertySystem_CAPS_staticMD5

Gets a new CngAlgorithm object that specifies the Message Digest 5 (MD5) hash algorithm.

System_CAPS_pubpropertySystem_CAPS_staticRsa

Gets a new CngAlgorithm object that specifies the RSA hash algorithm.

System_CAPS_pubpropertySystem_CAPS_staticSha1

Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 1 (SHA-1) algorithm.

System_CAPS_pubpropertySystem_CAPS_staticSha256

Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 256 (SHA-256) algorithm.

System_CAPS_pubpropertySystem_CAPS_staticSha384

Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 384 (SHA-384) algorithm.

System_CAPS_pubpropertySystem_CAPS_staticSha512

Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 512 (SHA-512) algorithm.

NameDescription
System_CAPS_pubmethodEquals(CngAlgorithm)

Compares the specified CngAlgorithm object to the current CngAlgorithm object.

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodGetHashCode()

Generates a hash value for the algorithm name that is embedded in the current CngAlgorithm 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 algorithm that the current CngAlgorithm object specifies.(Overrides Object.ToString().)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticEquality(CngAlgorithm, CngAlgorithm)

Determines whether two CngAlgorithm objects specify the same algorithm name.

System_CAPS_puboperatorSystem_CAPS_staticInequality(CngAlgorithm, CngAlgorithm)

Determines whether two CngAlgorithm objects do not specify the same algorithm.

The CngAlgorithm class is a utility class. It consists of static properties, comparison methods, and a private, internally maintained, algorithm name string.

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

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

Several Cryptography Next Generation (CNG) classes (such as CngKey) accept CngAlgorithm objects through an algorithm parameter. When the class receives the CngAlgorithm object, it retrieves the embedded algorithm name by calling the object's Algorithm property.

Therefore, CngAlgorithm serves as an enumeration of well-known algorithms. It lets you specify a well-known algorithm by using a strongly typed value instead of a string.

Universal Windows Platform
Available since 10
.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:
© 2016 Microsoft