ECDsaCng Class

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Source:

Cng.NotSupported.cs

Provides a Cryptography Next Generation (CNG) implementation of the Elliptic Curve Digital Signature Algorithm (ECDSA).

public ref class ECDsaCng sealed : System::Security::Cryptography::ECDsa

public sealed class ECDsaCng : System.Security.Cryptography.ECDsa

type ECDsaCng = class
    inherit ECDsa

Public NotInheritable Class ECDsaCng
Inherits ECDsa

Inheritance

Object

AsymmetricAlgorithm

ECAlgorithm

ECDsa

ECDsaCng

Examples

The following example shows how to use the ECDsaCng class to sign a message and how to use the signature to verify that the message has not been altered.

using System;
using System.IO;
using System.Security.Cryptography;
using System.Text;

class Alice
{
    public static void Main(string[] args)
    {
        Bob bob = new Bob();
        using (ECDsaCng dsa = new ECDsaCng())
        {
            dsa.HashAlgorithm = CngAlgorithm.Sha256;
             bob.key = dsa.Key.Export(CngKeyBlobFormat.EccPublicBlob);

             byte[] data = new byte[] { 21, 5, 8, 12, 207 };

             byte[] signature = dsa.SignData(data);

             bob.Receive(data, signature);
            }
    }
}
public class Bob
{
    public byte[] key;

    public void Receive(byte[] data, byte[] signature)
    {
        using (ECDsaCng ecsdKey = new ECDsaCng(CngKey.Import(key, CngKeyBlobFormat.EccPublicBlob)))
        {
            if (ecsdKey.VerifyData(data, signature))
                Console.WriteLine("Data is good");
            else
                Console.WriteLine("Data is bad");
        }
    }
}

Imports System.IO
Imports System.Security.Cryptography
Imports System.Text

Class Alice

    Public Shared Sub Main(ByVal args() As String)
        Dim bob As New Bob()
        If (True) Then
            Using dsa As New ECDsaCng()
                    dsa.HashAlgorithm = CngAlgorithm.Sha256
                    bob.key = dsa.Key.Export(CngKeyBlobFormat.EccPublicBlob)
                    Dim data() As Byte = {21, 5, 8, 12, 207}
                    Dim signature As Byte() = dsa.SignData(data)
                    bob.Receive(data, signature)
            End Using
        End If

    End Sub
End Class


Public Class Bob
    Public key() As Byte

    Public Sub Receive(ByVal data() As Byte, ByVal signature() As Byte)
        Using ecsdKey As New ECDsaCng(CngKey.Import(key, CngKeyBlobFormat.EccPublicBlob))
                If ecsdKey.VerifyData(data, signature) Then
                    Console.WriteLine("Data is good")
                Else
                    Console.WriteLine("Data is bad")
                End If
        End Using

    End Sub
End Class

Remarks

This class should only be used directly when doing platform interop with the Windows CNG library. When platform interop is not needed, you should use the ECDsa.Create factory methods instead of a specific derived implementation.

Constructors

ECDsaCng()	Initializes a new instance of the ECDsaCng class with a random key pair.
ECDsaCng(CngKey)	Initializes a new instance of the ECDsaCng class by using the specified CngKey object.
ECDsaCng(ECCurve)	Initializes a new instance of the ECDsaCng class whose public/private key pair is generated over the specified curve.
ECDsaCng(Int32)	Initializes a new instance of the ECDsaCng class with a specified target key size.

Fields

KeySizeValue	Represents the size, in bits, of the key modulus used by the asymmetric algorithm. (Inherited from AsymmetricAlgorithm)
LegalKeySizesValue	Specifies the key sizes that are supported by the asymmetric algorithm. (Inherited from AsymmetricAlgorithm)

Properties

HashAlgorithm	Gets or sets the hash algorithm to use when signing and verifying data.
Key	Gets or sets the key to use when signing and verifying data.
KeyExchangeAlgorithm	Gets the name of the key exchange algorithm. (Inherited from ECDsa)
KeySize	Gets or sets the size, in bits, of the key modulus used by the asymmetric algorithm.
LegalKeySizes	Gets the key sizes, in bits, that are supported by the KeySize property setter.
SignatureAlgorithm	Gets the name of the signature algorithm. (Inherited from ECDsa)

Methods

Clear()	Releases all resources used by the AsymmetricAlgorithm class. (Inherited from AsymmetricAlgorithm)
Dispose()	Releases all resources used by the current instance of the AsymmetricAlgorithm class. (Inherited from AsymmetricAlgorithm)
Dispose(Boolean)	Releases the unmanaged resources used by the AsymmetricAlgorithm class and optionally releases the managed resources. (Inherited from AsymmetricAlgorithm)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExportECPrivateKey()	Exports the current key in the ECPrivateKey format. (Inherited from ECDsa)
ExportECPrivateKeyPem()	Exports the current key in the ECPrivateKey format, PEM encoded. (Inherited from ECAlgorithm)
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password.
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password.
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Byte>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Char>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
ExportExplicitParameters(Boolean)	Exports the key and explicit curve parameters used by the Elliptic curve cryptography (ECC) object into an ECParameters object.
ExportParameters(Boolean)	Exports the key used by the Elliptic curve cryptography (ECC) object into an ECParameters object. If the key was created as a named curve, the Curve field contains named curve parameters; otherwise, it contains explicit parameters.
ExportPkcs8PrivateKey()	Exports the current key in the PKCS#8 PrivateKeyInfo format. (Inherited from AsymmetricAlgorithm)
ExportPkcs8PrivateKeyPem()	Exports the current key in the PKCS#8 PrivateKeyInfo format, PEM encoded. (Inherited from AsymmetricAlgorithm)
ExportSubjectPublicKeyInfo()	Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format. (Inherited from AsymmetricAlgorithm)
ExportSubjectPublicKeyInfoPem()	Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format, PEM encoded. (Inherited from AsymmetricAlgorithm)
FromXmlString(String, ECKeyXmlFormat)	Obsolete. Deserializes the key information from an XML string by using the specified format.
FromXmlString(String)	This method throws in all cases. (Inherited from ECDsa)
GenerateKey(ECCurve)	Generates a new ephemeral public/private key pair for the specified curve, replacing the current key.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetMaxSignatureSize(DSASignatureFormat)	Gets the largest size, in bytes, for a signature produced by this key in the indicated format. (Inherited from ECDsa)
GetType()	Gets the Type of the current instance. (Inherited from Object)
HashData(Byte[], Int32, Int32, HashAlgorithmName)	When overridden in a derived class, computes the hash value of the specified portion of a byte array by using the specified hashing algorithm. (Inherited from ECDsa)
HashData(Stream, HashAlgorithmName)	When overridden in a derived class, computes the hash value of the specified binary stream by using the specified hashing algorithm. (Inherited from ECDsa)
ImportECPrivateKey(ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from an ECPrivateKey structure, replacing the keys for this object. (Inherited from ECDsa)
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a byte-based password, replacing the keys for this object.
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a char-based password, replacing the keys for this object.
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)	Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object. (Inherited from ECDsa)
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Char>)	Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object. (Inherited from ECDsa)
ImportFromPem(ReadOnlySpan<Char>)	Imports an RFC 7468 PEM-encoded key, replacing the keys for this object. (Inherited from ECDsa)
ImportParameters(ECParameters)	Replaces the existing key that the current instance is working with by creating a new CngKey for the parameters structure.
ImportPkcs8PrivateKey(ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object.
ImportSubjectPublicKeyInfo(ReadOnlySpan<Byte>, Int32)	Imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object. (Inherited from ECDsa)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SignData(Byte[], HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it using the specified signature format. (Inherited from ECDsa)
SignData(Byte[], HashAlgorithmName)	Computes the hash value of the specified byte array using the specified hash algorithm and signs the resulting hash value. (Inherited from ECDsa)
SignData(Byte[], Int32, Int32, HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it using the specified signature format. (Inherited from ECDsa)
SignData(Byte[], Int32, Int32, HashAlgorithmName)	Computes the hash value of a portion of the specified byte array using the specified hash algorithm and signs the resulting hash value. (Inherited from ECDsa)
SignData(Byte[], Int32, Int32)	Generates a digital signature for the specified length of data, beginning at the specified offset.
SignData(Byte[])	Generates a signature for the specified data.
SignData(ReadOnlySpan<Byte>, HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it using the specified signature format. (Inherited from ECDsa)
SignData(ReadOnlySpan<Byte>, HashAlgorithmName)	Computes the hash value of the specified data and signs it. (Inherited from ECDsa)
SignData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it in the indicated format into the provided buffer. (Inherited from ECDsa)
SignData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName)	Computes the hash value of the specified data and signs it in the indicated format into the provided buffer. (Inherited from ECDsa)
SignData(Stream, HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it using the specified signature format. (Inherited from ECDsa)
SignData(Stream, HashAlgorithmName)	Computes the hash value of the specified stream using the specified hash algorithm and signs the resulting hash value. (Inherited from ECDsa)
SignData(Stream)	Generates a signature for the specified data stream, reading to the end of the stream.
SignDataCore(ReadOnlySpan<Byte>, HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it using the specified signature format. (Inherited from ECDsa)
SignDataCore(Stream, HashAlgorithmName, DSASignatureFormat)	Computes the hash value of the specified data and signs it using the specified signature format. (Inherited from ECDsa)
SignHash(Byte[], DSASignatureFormat)	Computes the ECDSA signature for the specified hash value in the indicated format. (Inherited from ECDsa)
SignHash(Byte[])	Generates a signature for the specified hash value.
SignHash(ReadOnlySpan<Byte>, DSASignatureFormat)	Computes the ECDSA signature for the specified hash value in the indicated format. (Inherited from ECDsa)
SignHash(ReadOnlySpan<Byte>, Span<Byte>, DSASignatureFormat)	Computes the ECDSA signature for the specified hash value in the indicated format into the provided buffer. (Inherited from ECDsa)
SignHash(ReadOnlySpan<Byte>, Span<Byte>)	Computes the ECDSA signature for the specified hash value into the provided buffer. (Inherited from ECDsa)
SignHash(ReadOnlySpan<Byte>)	Computes the ECDSA signature for the specified hash value. (Inherited from ECDsa)
SignHashCore(ReadOnlySpan<Byte>, DSASignatureFormat)	Computes the ECDSA signature for the specified hash value in the indicated format. (Inherited from ECDsa)
ToString()	Returns a string that represents the current object. (Inherited from Object)
ToXmlString(Boolean)	This method throws in all cases. (Inherited from ECDsa)
ToXmlString(ECKeyXmlFormat)	Obsolete. Serializes the key information to an XML string by using the specified format.
TryExportECPrivateKey(Span<Byte>, Int32)	Attempts to export the current key in the ECPrivateKey format into a provided buffer. (Inherited from ECDsa)
TryExportECPrivateKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded ECPrivateKey format into a provided buffer. (Inherited from ECAlgorithm)
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, PbeParameters, Span<Byte>, Int32)	Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a byte-based password.
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, PbeParameters, Span<Byte>, Int32)	Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a char-based password.
TryExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Byte>, PbeParameters, Span<Char>, Int32)	Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
TryExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Char>, PbeParameters, Span<Char>, Int32)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
TryExportPkcs8PrivateKey(Span<Byte>, Int32)	Attempts to export the current key in the PKCS#8 PrivateKeyInfo format into a provided buffer.
TryExportPkcs8PrivateKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded PKCS#8 PrivateKeyInfo format into a provided buffer. (Inherited from AsymmetricAlgorithm)
TryExportSubjectPublicKeyInfo(Span<Byte>, Int32)	Attempts to export the current key in the X.509 SubjectPublicKeyInfo format into a provided buffer. (Inherited from ECDsa)
TryExportSubjectPublicKeyInfoPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded X.509 SubjectPublicKeyInfo format into a provided buffer. (Inherited from AsymmetricAlgorithm)
TryHashData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, Int32)	Attempts to compute the hash value of the specified read-only span of bytes into the provided destination by using the specified hashing algorithm. (Inherited from ECDsa)
TrySignData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, DSASignatureFormat, Int32)	Attempts to create the ECDSA signature for the specified data in the indicated format into the provided buffer. (Inherited from ECDsa)
TrySignData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, Int32)	Attempts to compute the ECDSA digital signature for the specified read-only span of bytes into the provided destination by using the specified hashing algorithm and the current key. (Inherited from ECDsa)
TrySignDataCore(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, DSASignatureFormat, Int32)	Attempts to create the ECDSA signature for the specified data in the indicated format into the provided buffer. (Inherited from ECDsa)
TrySignHash(ReadOnlySpan<Byte>, Span<Byte>, DSASignatureFormat, Int32)	Attempts to create the ECDSA signature for the specified hash value in the indicated format into the provided buffer. (Inherited from ECDsa)
TrySignHash(ReadOnlySpan<Byte>, Span<Byte>, Int32)	Attempts to compute the ECDSA digital signature for the specified read-only span of bytes representing a data hash into the provided destination by using the current key.
TrySignHashCore(ReadOnlySpan<Byte>, Span<Byte>, DSASignatureFormat, Int32)	Attempts to create the ECDSA signature for the specified hash value in the indicated format into the provided buffer. (Inherited from ECDsa)
VerifyData(Byte[], Byte[], HashAlgorithmName, DSASignatureFormat)	Verifies that a digital signature is valid for the provided data. (Inherited from ECDsa)
VerifyData(Byte[], Byte[], HashAlgorithmName)	Verifies that a digital signature is appropriate for the current key and provided data with a specified hash algorithm. (Inherited from ECDsa)
VerifyData(Byte[], Byte[])	Verifies the digital signature of the specified data.
VerifyData(Byte[], Int32, Int32, Byte[], HashAlgorithmName, DSASignatureFormat)	Verifies that a digital signature is valid for the provided data. (Inherited from ECDsa)
VerifyData(Byte[], Int32, Int32, Byte[], HashAlgorithmName)	Verifies that a digital signature is appropriate for the current key and provided portion of data with a specified hash algorithm. (Inherited from ECDsa)
VerifyData(Byte[], Int32, Int32, Byte[])	Verifies a signature for the specified length of data, beginning at the specified offset.
VerifyData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, HashAlgorithmName, DSASignatureFormat)	Verifies that a digital signature is valid for the provided data. (Inherited from ECDsa)
VerifyData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, HashAlgorithmName)	Verifies that a digital signature is appropriate for the current key and provided data with a specified hash algorithm. (Inherited from ECDsa)
VerifyData(Stream, Byte[], HashAlgorithmName, DSASignatureFormat)	Verifies that a digital signature is valid for the provided data. (Inherited from ECDsa)
VerifyData(Stream, Byte[], HashAlgorithmName)	Verifies that a digital signature is appropriate for the current key and provided data with a specified hash algorithm. (Inherited from ECDsa)
VerifyData(Stream, Byte[])	Verifies the digital signature of the specified data stream, reading to the end of the stream.
VerifyDataCore(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, HashAlgorithmName, DSASignatureFormat)	Verifies that a digital signature is valid for the provided data. (Inherited from ECDsa)
VerifyDataCore(Stream, ReadOnlySpan<Byte>, HashAlgorithmName, DSASignatureFormat)	Verifies that a digital signature is valid for the provided data. (Inherited from ECDsa)
VerifyHash(Byte[], Byte[], DSASignatureFormat)	Verifies that a digital signature is valid for the provided hash. (Inherited from ECDsa)
VerifyHash(Byte[], Byte[])	Verifies that a digital signature is appropriate for the current key and provided data hash.
VerifyHash(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, DSASignatureFormat)	Verifies that a digital signature is valid for the provided hash. (Inherited from ECDsa)
VerifyHash(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>)	Verifies that a digital signature is appropriate for the current key and provided data hash.
VerifyHashCore(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, DSASignatureFormat)	Verifies that a digital signature is valid for the provided hash. (Inherited from ECDsa)