CngAlgorithm Class

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Source:

CngAlgorithm.cs

Encapsulates the name of an encryption algorithm.

public ref class CngAlgorithm sealed : IEquatable<System::Security::Cryptography::CngAlgorithm ^>

public sealed class CngAlgorithm : IEquatable<System.Security.Cryptography.CngAlgorithm>

type CngAlgorithm = class
    interface IEquatable<CngAlgorithm>

Public NotInheritable Class CngAlgorithm
Implements IEquatable(Of CngAlgorithm)

Inheritance

Object

CngAlgorithm

Implements

IEquatable<CngAlgorithm>

Remarks

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.

Note

CNG classes don't work on non-Windows platforms.

Constructors

CngAlgorithm(String)

Initializes a new instance of the CngAlgorithm class.

Properties

Algorithm	Gets the algorithm name that the current CngAlgorithm object specifies.
ECDiffieHellman	Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm whose curve is described via a key property.
ECDiffieHellmanP256	Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-256 curve.
ECDiffieHellmanP384	Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-384 curve.
ECDiffieHellmanP521	Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-521 curve.
ECDsa	Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) whose curve is described via a key property.
ECDsaP256	Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-256 curve.
ECDsaP384	Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-384 curve.
ECDsaP521	Gets a new CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-521 curve.
MD5	Gets a new CngAlgorithm object that specifies the Message Digest 5 (MD5) hash algorithm.
Rsa	Gets a new CngAlgorithm object that specifies the RSA hash algorithm.
Sha1	Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 1 (SHA-1) algorithm.
Sha256	Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 256 (SHA-256) algorithm.
Sha384	Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 384 (SHA-384) algorithm.
Sha512	Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 512 (SHA-512) algorithm.

Methods

Equals(CngAlgorithm)	Compares the specified CngAlgorithm object to the current CngAlgorithm object.
Equals(Object)	Compares the specified object to the current CngAlgorithm object.
GetHashCode()	Generates a hash value for the algorithm name that is embedded in the current CngAlgorithm object.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Gets the name of the algorithm that the current CngAlgorithm object specifies.

Operators

Equality(CngAlgorithm, CngAlgorithm)	Determines whether two CngAlgorithm objects specify the same algorithm name.
Inequality(CngAlgorithm, CngAlgorithm)	Determines whether two CngAlgorithm objects do not specify the same algorithm.