ECC Control

Properties   Methods   Events   Config Settings   Errors  

The ECC (Elliptic Curve Cryptography) control implements ECDSA, EdDSA, ECDH, and ECIES operations.

Syntax

ECC

Remarks

The ECC (Elliptic Curve Cryptography) control implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), and ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The control supports the following common operations:

• CreateKey allows key creation using algorithms such as secp256r1, secp384r1, secp521r1, X25519, X448, Ed25519, Ed448, and more.
• ComputeSecret computes a shared secret between two parties using a public and private key (ECDH).
• Sign and VerifySignature provides a way to digitally sign data and verify signatures (ECDSA and EdDSA).
• Encrypt and Decrypt encrypt and decrypt data using a public and private key (ECIES).

The control is very flexible and offers many properties and configuration settings to configure the control. The sections below detail the use of the control for each of the major operations listed above.

Key Creation and Management

CreateKey creates a new public and private key.

When this method is called Key is populated with the generated key. The KeyPublicKey and KeyPrivateKey property hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.

The KeyAlgorithm parameter specifies the algorithm for which the key is intended to be used. Possible values are:

NIST, Koblitz, and Brainpool Curve Notes

Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyRx
• KeyRy

The private key consists of one value:

• KeyK

Curve25519 and Curve448 Notes

Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.

KeyXPk holds the public key.

KeyXSk holds the private key.

Create Key Example (secp256r1 - PEM)

//Create a key using secp256r1 Ecc ecc = new Ecc(); ecc.CreateKey("secp256r1"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1" string privKey = ecc.Key.PrivateKey; //PEM formatted key string pubKey = ecc.Key.PublicKey; //PEM formatted key //Load the saved key ecc.Reset(); ecc.Key.PublicKey = pubKey; ecc.Key.PrivateKey = privKey; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"

Create Key Example (secp256r1 - Raw Key Params)

//Create a key using secp256r1 and store/load the key using the individual params Ecc ecc = new Ecc(); ecc.CreateKey("secp256r1"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1" byte[] K = ecc.Key.KB; //Private key param byte[] Rx = ecc.Key.RxB; //Public key param byte[] Ry = ecc.Key.RyB; //Public key param //Load the saved key ecc.Reset(); ecc.Key.Algorithm = ECAlgorithms.eaSecp256r1; //This MUST be set manually when using key params directly ecc.Key.KB = K; ecc.Key.RxB = Rx; ecc.Key.RyB = Ry; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"

Create Key Example (Ed25519 - PEM)

//Create a key using Ed25519 Ecc ecc = new Ecc(); ecc.CreateKey("Ed25519"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519" string privKey = ecc.Key.PrivateKey; //PEM formatted key string pubKey = ecc.Key.PublicKey; //PEM formatted key //Load the saved key ecc.Reset(); ecc.Key.PublicKey = pubKey; ecc.Key.PrivateKey = privKey; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"

Create Key Example (Ed25519 - Raw Key Params)

//Create a key using Ed25519 and store/load the key using the individual params Ecc ecc = new Ecc(); ecc.CreateKey("Ed25519"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519" byte[] XPk = ecc.Key.XPkB; //Public key data byte[] XSk = ecc.Key.XSkB; //Secret key data //Load the saved key ecc.Reset(); ecc.Key.Algorithm = ECAlgorithms.eaEd25519; //This MUST be set manually when using key params directly ecc.Key.XPkB = XPk; ecc.Key.XSkB = XSk; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"

Compute Secret (ECDH)

This method computes a shared secret using Elliptic Curve Diffie Hellman (ECDH).

When this method is called the control will use the public key specified by RecipientKeyPublicKey and the private key specified by Key to compute a shared secret, or secret agreement. The ComputeSecretKDF property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by SharedSecret. The following properties are applicable when calling this method:

• Key (required)
• RecipientKeyPublicKey (required)
• ComputeSecretKDF (optional)

See ComputeSecretKDF for details on advanced settings that may be applicable for the chosen algorithm.

Keys created with the Ed25519 and Ed448 algorithms are not supported when calling this method.

Compute Secret Example

//Create a key for Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("X25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Create a key for Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("X25519"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Note: the public keys must be exchanged between parties by some mechanism //Create the shared secret on Party 1 ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; //Private key of this party ecc1.RecipientKey.PublicKey = ecc2_pub; //Public key of other party ecc1.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage ecc1.ComputeSecret(); Console.WriteLine(ecc1.SharedSecret); //Create the shared secret on Party 2 ecc2.Reset(); ecc2.Key.PrivateKey = ecc2_priv; //Private key of this party ecc2.RecipientKey.PublicKey = ecc1_pub; //Public key of other party ecc2.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage ecc2.ComputeSecret(); Console.WriteLine(ecc2.SharedSecret); //This will match the shared secret created by ecc1.

Signing (ECDSA and EdDSA)

Sign will create a hash signature using ECDSA or EdDSA. The control will use the key specified by Key to has the input data and sign the resulting hash.

Key must contain a private key created with a valid ECDSA or EdDSA algorithm. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for signing are:

• NIST Curves (secp256r1, secp384r1, secp521r1)
• Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
• Brainpool Curves
• Ed25519 and Ed448

See CreateKey for details about key creation and algorithms.

When this method is called data will be read from the InputFile or InputMessage.

The hash to be signed will be computed using the specified HashAlgorithm. The computed hash is stored in the HashValue property. The signed hash is stored in the HashSignature property.

To sign as hash without first computing it set HashValue to a previously computed hash for the input data. Note: HashValue is not applicable when signing with a PureEdDSA algorithm such as "Ed25519" or "Ed448".

The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

After calling Sign the public key must be sent to the recipient along with HashSignature and original input data so the other party may perform signature verification.

The following properties are applicable when calling this method:

• Key (required)
• HashAlgorithm (applicable to ECDSA only)
• HashEdDSA (applicable to EdDSA only)
• HashValue (not applicable to PureEdDSA)
• UseHex

The following properties are populated after calling this method:

• HashValue
• HashSignature

EdDSA Notes

When the KeyAlgorithm is Ed25519 or Ed448 the following additional parameters are applicable:

• HashEdDSA
• EdDSAContext

EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or as HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the HashEdDSA property. By default the control uses the PureEdDSA algorithm.

The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA HashValue is not applicable.

When using a HashEdDSA algorithm the input is pre-hashed and supports a single pass over the data during the signing operation. To enable HashEdDSA set HashEdDSA to True.

To specify context data when using Ed25519 or Ed448 set EdDSAContext.

Sign And Verify Example (ECDSA)

//Create an ECDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("secp256r1"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - PureEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - HashEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.HashEdDSA = true; //Use "ed25519ph" ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.HashEdDSA = true; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Verifying (ECDSA and EdDSA)

VerifySignature will verify a hash signature and return True if successful or False otherwise.

Before calling this method specify the input file by setting InputFile or InputMessage.

A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Specify the hash signature in HashSignature.

When this method is called the control will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

To verify the hash signature without first computing the hash simply specify HashValue before calling this method. Note: HashValue is not applicable when the message was signed with a PureEdDSA algorithm such as Ed25519 or Ed448.

The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.

The following properties are applicable when calling this method:

• HashSignature (required)
• SignerKey (required)
• EdDSAContext (applicable to EdDSA only)
• HashAlgorithm (applicable to ECDSA only)
• HashEdDSA (applicable to EdDSA only)
• HashValue (not applicable to PureEdDSA)
• UseHex

Sign And Verify Example (ECDSA)

//Create an ECDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("secp256r1"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - PureEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - HashEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.HashEdDSA = true; //Use "ed25519ph" ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.HashEdDSA = true; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Encrypting (ECIES)

Encrypt encrypts the specified data with the ECDSA public key specified in RecipientKey.

Encryption is performed using ECIES which requires an ECDSA key. RecipientKey must contain an ECDSA key. Algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

• NIST Curves (secp256r1, secp384r1, secp521r1)
• Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
• Brainpool Curves

See CreateKey for details about key creation and algorithms.

When this method is called the control will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output set UseHex to True.

The following properties are applicable when calling this method:

• EncryptionAlgorithm
• HMACAlgorithm
• HMACOptionalInfo
• HMACKeySize
• IV
• KDF
• KDFHashAlgorithm
• KDFOptionalInfo
• UseHex

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Encrypt and Decrypt Example

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (AES with IV)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); //Use an IV (16 bytes for AES) - In a real environment this should be random byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F }; ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc1.IVB = IV; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message and the IV to Party 2 //Decrypt the message using the private key for Party 2 and the IV ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc2.IVB = IV; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (XOR Encryption Algorithm)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (KDF Options)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.KDF = "KDF1"; //Use KDF1 ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.KDF = "KDF1"; ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Decrypting (ECIES)

Decrypt decrypts the specified data with the ECDSA private key specified in Key.

Decryption is performed using ECIES which requires an ECDSA key. Key must contain an ECDSA key. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

• NIST Curves (secp256r1, secp384r1, secp521r1)
• Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
• Brainpool Curves

See CreateKey for details about key creation and algorithms.

When this method is called the control will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set UseHex to True.

The following properties are applicable when calling this method:

• EncryptionAlgorithm
• HMACAlgorithm
• HMACOptionalInfo
• HMACKeySize
• IV
• KDF
• KDFHashAlgorithm
• KDFOptionalInfo
• UseHex

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Encrypt and Decrypt Example

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (AES with IV)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); //Use an IV (16 bytes for AES) - In a real environment this should be random byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F }; ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc1.IVB = IV; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message and the IV to Party 2 //Decrypt the message using the private key for Party 2 and the IV ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc2.IVB = IV; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (XOR Encryption Algorithm)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (KDF Options)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.KDF = "KDF1"; //Use KDF1 ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.KDF = "KDF1"; ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Property List

---

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

ComputeSecretKDF Property (ECC Control)

The key derivation function.

Syntax

ecccontrol.ComputeSecretKDF[=integer]

Possible Values

ekdSHA1(0), 
ekdSHA256(1), 
ekdSHA384(2), 
ekdSHA512(3), 
ekdMD2(4), 
ekdMD4(5), 
ekdMD5(6), 
ekdHMACSHA1(7), 
ekdHMACSHA256(8), 
ekdHMACSHA384(9), 
ekdHMACSHA512(10), 
ekdHMACMD5(11), 
ekdTLS(12), 
ekdConcat(13)

Default Value

1

Remarks

This property specifies the key derivation function (KDF) and algorithm to use when calling ComputeSecret.

Possible values are:

HMAC Notes

If an HMAC algorithm is selected HMACKey may optionally be set to specify the key.

TLS Notes

When set to TLS, TLSSeed and TLSLabel are required. In addition PrependSecret and AppendSecret are not applicable.

Concat Notes

If Concat is selected the following configuration settings are applicable:

• ConcatAlgorithmId (required)
• ConcatPartyUInfo (required)
• ConcatPartyVInfo (required)
• ConcatSuppPubInfo
• ConcatSuppPrivInfo
• ConcatHashAlgorithm

Data Type

Integer

EncryptionAlgorithm Property (ECC Control)

The encryption algorithm to use.

Syntax

ecccontrol.EncryptionAlgorithm[=integer]

Possible Values

iesAES(0), 
iesTripleDES(1), 
iesXOR(2)

Default Value

0

Remarks

This setting specifies the encryption algorithm to use when Encrypt is called. This must also be set before calling Decrypt to match the algorithm used during the initial encryption.

Possible values are:

• 0 (iesAES - default)
• 1 (iesTripleDES)
• 2 (iesXOR)

AES Notes

When EncryptionAlgorithm is set to iesAES AES CBC with a default key size of 256 bits is used. To specify a different key size set EncryptionKeySize.

Data Type

Integer

HashAlgorithm Property (ECC Control)

The hash algorithm used for hash computation.

Syntax

ecccontrol.HashAlgorithm[=integer]

Possible Values

ehaSHA1(0), 
ehaSHA224(1), 
ehaSHA256(2), 
ehaSHA384(3), 
ehaSHA512(4), 
ehaMD2(5), 
ehaMD4(6), 
ehaMD5(7), 
ehaMD5SHA1(8), 
ehaRIPEMD160(9)

Default Value

2

Remarks

This property specifies the hash algorithm used for hash computation. This is only applicable when calling Sign or VerifySignature and KeyAlgorithm specifies a ECDSA key (NIST, Koblitz, or Brainpool curve). Possible values are:

When KeyAlgorithm specified an EdDSA key this setting is not applicable, as the hash algorithm is defined by the specification as SHA-512 for Ed25519 and SHAKE-256 for Ed448.

Data Type

Integer

HashEdDSA Property (ECC Control)

Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key.

Syntax

ecccontrol.HashEdDSA[=boolean]

Default Value

False

Remarks

This setting specifies whether to use the HashEdDSA algorithm when signing and verifying with Ed25519 or Ed448 keys.

If set to True the control will use the HashEdDSA algorithm (Ed25519ph or Ed448ph) when signing and verifying. When using a HashEdDSA algorithm the input is pre-hashed and supports a single pass over the data during the signing operation.

If set to False (Default) the control will use the PureEdDSA algorithm (Ed25519 or Ed448) when signing. The PureEdDSA requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means even if it is feasible to compute collisions for the hash function, the algorithm is still secure.

This property is only applicable when calling Sign and KeyAlgorithm is set to Ed25519 or Ed448.

If this property is set before calling Sign it must be set before calling VerifySignature.

Data Type

Boolean

HashSignature Property (ECC Control)

The hash signature.

Syntax

ecccontrol.HashSignature[=string]

Default Value

""

Remarks

This property holds the computed hash signature. This is populated after calling Sign. This must be set before calling VerifySignature.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .HashSignatureB.

Data Type

Binary String

HashValue Property (ECC Control)

The hash value of the data.

Syntax

ecccontrol.HashValue[=string]

Default Value

""

Remarks

This property holds the computed hash value for the specified data. This is populated when calling Sign or VerifySignature when an input file is specified by setting InputFile or InputMessage.

Pre-existing hash values may be set to this property before calling Sign or VerifySignature. If you know the hash value prior to using the control you may specify the pre-computed hash value here.

This setting is not applicable to PureEdDSA algorithms. If KeyAlgorithm is Ed25519 or Ed448 and HashEdDSA is False (default), the PureEdDSA algorithm is use and HashValue is not applicable.

Hash Notes

The control will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by InputFile or InputMessage the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set the control will only sign the hash or verify the hash signature. Setting InputFile or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .HashValueB.

Data Type

Binary String

HMACAlgorithm Property (ECC Control)

The HMAC algorithm to use during encryption.

Syntax

ecccontrol.HMACAlgorithm[=integer]

Possible Values

iesHMACSHA1(0), 
iesHMACSHA224(1), 
iesHMACSHA256(2), 
iesHMACSHA384(3), 
iesHMACSHA512(4), 
iesHMACRIPEMD160(5)

Default Value

2

Remarks

This property specifies the HMAC algorithm to use when encrypting. The HMAC algorithm is used when Encrypt and Decrypt are called to protect and verify data. Possible values are:

• 0 (iesHMACSHA1)
• 1 (iesHMACSHA224)
• 2 (iesHMACSHA256 - Default)
• 3 (iesHMACSHA384)
• 4 (iesHMACSHA512)
• 5 (iesHMACRIPEMD160)

This property is only applicable when calling Encrypt or Decrypt.

Data Type

Integer

InputFile Property (ECC Control)

The file to process.

Syntax

ecccontrol.InputFile[=string]

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

InputMessage Property (ECC Control)

The message to process.

Syntax

ecccontrol.InputMessage[=string]

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .InputMessageB.

Data Type

Binary String

IV Property (ECC Control)

The initialization vector (IV) used when encrypting.

Syntax

ecccontrol.IV[=string]

Default Value

""

Remarks

This property optionally specifies an IV to be used when calling Encrypt or Decrypt. If specified the IV is used by EncryptionAlgorithm during encryption.

If not specified the control will create an IV filled with null bytes (zeros). Since the encryption key is only used once the use of null bytes in the IV is considered acceptable and is a standard practice.

The length of the IV should be as follows:

This setting is not applicable when EncryptionAlgorithm is set to XOR.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .IVB.

Data Type

Binary String

KDF Property (ECC Control)

The key derivation function used during encryption and decryption.

Syntax

ecccontrol.KDF[=string]

Default Value

"KDF2"

Remarks

This property specifies the key derivation function (KDF) to use when encrypting and decrypting. Possible values are:

• "KDF1"
• "KDF2" (Default)

The KDFHashAlgorithm specifies the hash algorithm used in conjunction with the specified KDF.

This property is only applicable when calling Encrypt or Decrypt.

Data Type

String

KDFHashAlgorithm Property (ECC Control)

The KDF hash algorithm to use when encrypting and decrypting.

Syntax

ecccontrol.KDFHashAlgorithm[=integer]

Possible Values

iesSHA1(0), 
iesSHA224(1), 
iesSHA256(2), 
iesSHA384(3), 
iesSHA512(4)

Default Value

2

Remarks

This property specifies the hash algorithm to use in when deriving a key using the specified KDF. Possible values are:

• 0 (iesSHA1)
• 1 (iesSHA224)
• 2 (iesSHA256)
• 3 (iesSHA384)
• 4 (iesSHA512)

This property is only applicable when calling Encrypt or Decrypt.

Data Type

Integer

KeyAlgorithm Property (ECC Control)

This property holds the algorithm associated with the key.

Syntax

ecccontrol.KeyAlgorithm[=integer]

Possible Values

eaSecp256r1(0), 
eaSecp384r1(1), 
eaSecp521r1(2), 
eaEd25519(3), 
eaEd448(4), 
eaX25519(5), 
eaX448(6), 
eaSecp160k1(7), 
eaSecp192k1(8), 
eaSecp224k1(9), 
eaSecp256k1(10), 
eaBrainpoolP160r1(11), 
eaBrainpoolP192r1(12), 
eaBrainpoolP224r1(13), 
eaBrainpoolP256r1(14), 
eaBrainpoolP320r1(15), 
eaBrainpoolP384r1(16), 
eaBrainpoolP512r1(17), 
eaBrainpoolP160t1(18), 
eaBrainpoolP192t1(19), 
eaBrainpoolP224t1(20), 
eaBrainpoolP256t1(21), 
eaBrainpoolP320t1(22), 
eaBrainpoolP384t1(23), 
eaBrainpoolP512t1(24)

Default Value

0

Remarks

This property holds the algorithm associated with the key. Possible values are:

• 0 (eaSecp256r1)
• 1 (eaSecp384r1)
• 2 (eaSecp521r1)
• 3 (eaEd25519)
• 4 (eaEd448)
• 5 (eaX25519)
• 6 (eaX448)
• 7 (eaSecp160k1)
• 8 (eaSecp192k1)
• 9 (eaSecp224k1)
• 10 (eaSecp256k1)
• 11 (eaBrainpoolP160r1)
• 12 (eaBrainpoolP192r1)
• 13 (eaBrainpoolP224r1)
• 14 (eaBrainpoolP256r1)
• 15 (eaBrainpoolP320r1)
• 16 (eaBrainpoolP384r1)
• 17 (eaBrainpoolP512r1)
• 18 (eaBrainpoolP160t1)
• 19 (eaBrainpoolP192t1)
• 20 (eaBrainpoolP224t1)
• 21 (eaBrainpoolP256t1)
• 22 (eaBrainpoolP320t1)
• 23 (eaBrainpoolP384t1)
• 24 (eaBrainpoolP512t1)

When assigning a key using the PEM formatted KeyPrivateKey and KeyPublicKey the KeyAlgorithm property will be automatically updated with the key algorithm.

When assigning a key using the raw key parameters (KeyK, KeyRx, and KeyRy for NIST or KeyXPk, and KeyXSk for Curve25519/Curve448) the KeyAlgorithm property must be set manually to the key algorithm.

The following table summarizes the supported operations for keys created with each algorithm:

Data Type

Integer

KeyK Property (ECC Control)

Represent the private key (K) parameter.

Syntax

ecccontrol.KeyK[=string]

Default Value

""

Remarks

Represent the private key (K) parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyKB.

Data Type

Binary String

KeyPrivateKey Property (ECC Control)

This property is a PEM formatted private key.

Syntax

ecccontrol.KeyPrivateKey[=string]

Default Value

""

Remarks

This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.

Data Type

String

KeyPublicKey Property (ECC Control)

This property is a PEM formatted public key.

Syntax

ecccontrol.KeyPublicKey[=string]

Default Value

""

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

KeyRx Property (ECC Control)

Represents the public key's Rx parameter.

Syntax

ecccontrol.KeyRx[=string]

Default Value

""

Remarks

Represents the public key's Rx parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyRxB.

Data Type

Binary String

KeyRy Property (ECC Control)

Represents the public key's Ry parameter.

Syntax

ecccontrol.KeyRy[=string]

Default Value

""

Remarks

Represents the public key's Ry parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyRyB.

Data Type

Binary String

KeyXPk Property (ECC Control)

Holds the public key data.

Syntax

ecccontrol.KeyXPk[=string]

Default Value

""

Remarks

Holds the public key data.

Note: This value is only applicable when using Curve25519 or Curve448.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyXPkB.

Data Type

Binary String

KeyXSk Property (ECC Control)

Holds the private key data.

Syntax

ecccontrol.KeyXSk[=string]

Default Value

""

Remarks

Holds the private key data.

Note: This value is only applicable when using Curve25519 or Curve448.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyXSkB.

Data Type

Binary String

OutputFile Property (ECC Control)

The output file when encrypting or decrypting.

Syntax

ecccontrol.OutputFile[=string]

Default Value

""

Remarks

This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to Encrypt and Decrypt.

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

OutputMessage Property (ECC Control)

The output message when encrypting or decrypting.

Syntax

ecccontrol.OutputMessage

Default Value

""

Remarks

This property will be populated with the output after calling Encrypt or Decrypt if OutputFile is not set.

This property is only applicable to Encrypt and Decrypt.

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .OutputMessageB.

This property is read-only and not available at design time.

Data Type

Binary String

Overwrite Property (ECC Control)

Indicates whether or not the control should overwrite files.

Syntax

ecccontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property indicates whether or not the control will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

RecipientKeyAlgorithm Property (ECC Control)

This property holds the algorithm associated with the key.

Syntax

ecccontrol.RecipientKeyAlgorithm[=integer]

Possible Values

eaSecp256r1(0), 
eaSecp384r1(1), 
eaSecp521r1(2), 
eaEd25519(3), 
eaEd448(4), 
eaX25519(5), 
eaX448(6), 
eaSecp160k1(7), 
eaSecp192k1(8), 
eaSecp224k1(9), 
eaSecp256k1(10), 
eaBrainpoolP160r1(11), 
eaBrainpoolP192r1(12), 
eaBrainpoolP224r1(13), 
eaBrainpoolP256r1(14), 
eaBrainpoolP320r1(15), 
eaBrainpoolP384r1(16), 
eaBrainpoolP512r1(17), 
eaBrainpoolP160t1(18), 
eaBrainpoolP192t1(19), 
eaBrainpoolP224t1(20), 
eaBrainpoolP256t1(21), 
eaBrainpoolP320t1(22), 
eaBrainpoolP384t1(23), 
eaBrainpoolP512t1(24)

Default Value

0

Remarks

This property holds the algorithm associated with the key. Possible values are:

• 0 (eaSecp256r1)
• 1 (eaSecp384r1)
• 2 (eaSecp521r1)
• 3 (eaEd25519)
• 4 (eaEd448)
• 5 (eaX25519)
• 6 (eaX448)
• 7 (eaSecp160k1)
• 8 (eaSecp192k1)
• 9 (eaSecp224k1)
• 10 (eaSecp256k1)
• 11 (eaBrainpoolP160r1)
• 12 (eaBrainpoolP192r1)
• 13 (eaBrainpoolP224r1)
• 14 (eaBrainpoolP256r1)
• 15 (eaBrainpoolP320r1)
• 16 (eaBrainpoolP384r1)
• 17 (eaBrainpoolP512r1)
• 18 (eaBrainpoolP160t1)
• 19 (eaBrainpoolP192t1)
• 20 (eaBrainpoolP224t1)
• 21 (eaBrainpoolP256t1)
• 22 (eaBrainpoolP320t1)
• 23 (eaBrainpoolP384t1)
• 24 (eaBrainpoolP512t1)

When assigning a key using the PEM formatted RecipientKeyPrivateKey and RecipientKeyPublicKey the RecipientKeyAlgorithm property will be automatically updated with the key algorithm.

When assigning a key using the raw key parameters (RecipientKeyK, RecipientKeyRx, and RecipientKeyRy for NIST or RecipientKeyXPk, and RecipientKeyXSk for Curve25519/Curve448) the RecipientKeyAlgorithm property must be set manually to the key algorithm.

The following table summarizes the supported operations for keys created with each algorithm:

Data Type

Integer

RecipientKeyPublicKey Property (ECC Control)

This property is a PEM formatted public key.

Syntax

ecccontrol.RecipientKeyPublicKey[=string]

Default Value

""

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

RecipientKeyRx Property (ECC Control)

Represents the public key's Rx parameter.

Syntax

ecccontrol.RecipientKeyRx[=string]

Default Value

""

Remarks

Represents the public key's Rx parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyRxB.

Data Type

Binary String

RecipientKeyRy Property (ECC Control)

Represents the public key's Ry parameter.

Syntax

ecccontrol.RecipientKeyRy[=string]

Default Value

""

Remarks

Represents the public key's Ry parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyRyB.

Data Type

Binary String

RecipientKeyXPk Property (ECC Control)

Holds the public key data.

Syntax

ecccontrol.RecipientKeyXPk[=string]

Default Value

""

Remarks

Holds the public key data.

Note: This value is only applicable when using Curve25519 or Curve448.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyXPkB.

Data Type

Binary String

SharedSecret Property (ECC Control)

The computed shared secret.

Syntax

ecccontrol.SharedSecret

Default Value

""

Remarks

This property holds the shared secret computed by ComputeSecret.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SharedSecretB.

This property is read-only.

Data Type

Binary String

SignerKeyAlgorithm Property (ECC Control)

This property holds the algorithm associated with the key.

Syntax

ecccontrol.SignerKeyAlgorithm[=integer]

Possible Values

eaSecp256r1(0), 
eaSecp384r1(1), 
eaSecp521r1(2), 
eaEd25519(3), 
eaEd448(4), 
eaX25519(5), 
eaX448(6), 
eaSecp160k1(7), 
eaSecp192k1(8), 
eaSecp224k1(9), 
eaSecp256k1(10), 
eaBrainpoolP160r1(11), 
eaBrainpoolP192r1(12), 
eaBrainpoolP224r1(13), 
eaBrainpoolP256r1(14), 
eaBrainpoolP320r1(15), 
eaBrainpoolP384r1(16), 
eaBrainpoolP512r1(17), 
eaBrainpoolP160t1(18), 
eaBrainpoolP192t1(19), 
eaBrainpoolP224t1(20), 
eaBrainpoolP256t1(21), 
eaBrainpoolP320t1(22), 
eaBrainpoolP384t1(23), 
eaBrainpoolP512t1(24)

Default Value

0

Remarks

This property holds the algorithm associated with the key. Possible values are:

• 0 (eaSecp256r1)
• 1 (eaSecp384r1)
• 2 (eaSecp521r1)
• 3 (eaEd25519)
• 4 (eaEd448)
• 5 (eaX25519)
• 6 (eaX448)
• 7 (eaSecp160k1)
• 8 (eaSecp192k1)
• 9 (eaSecp224k1)
• 10 (eaSecp256k1)
• 11 (eaBrainpoolP160r1)
• 12 (eaBrainpoolP192r1)
• 13 (eaBrainpoolP224r1)
• 14 (eaBrainpoolP256r1)
• 15 (eaBrainpoolP320r1)
• 16 (eaBrainpoolP384r1)
• 17 (eaBrainpoolP512r1)
• 18 (eaBrainpoolP160t1)
• 19 (eaBrainpoolP192t1)
• 20 (eaBrainpoolP224t1)
• 21 (eaBrainpoolP256t1)
• 22 (eaBrainpoolP320t1)
• 23 (eaBrainpoolP384t1)
• 24 (eaBrainpoolP512t1)

When assigning a key using the PEM formatted SignerKeyPrivateKey and SignerKeyPublicKey the SignerKeyAlgorithm property will be automatically updated with the key algorithm.

When assigning a key using the raw key parameters (SignerKeyK, SignerKeyRx, and SignerKeyRy for NIST or SignerKeyXPk, and SignerKeyXSk for Curve25519/Curve448) the SignerKeyAlgorithm property must be set manually to the key algorithm.

The following table summarizes the supported operations for keys created with each algorithm:

Data Type

Integer

SignerKeyPublicKey Property (ECC Control)

This property is a PEM formatted public key.

Syntax

ecccontrol.SignerKeyPublicKey[=string]

Default Value

""

Remarks

This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.

Data Type

String

SignerKeyRx Property (ECC Control)

Represents the public key's Rx parameter.

Syntax

ecccontrol.SignerKeyRx[=string]

Default Value

""

Remarks

Represents the public key's Rx parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyRxB.

Data Type

Binary String

SignerKeyRy Property (ECC Control)

Represents the public key's Ry parameter.

Syntax

ecccontrol.SignerKeyRy[=string]

Default Value

""

Remarks

Represents the public key's Ry parameter.

Note: This value is only applicable when using an NIST, Koblitz, or Brainpool curve.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyRyB.

Data Type

Binary String

SignerKeyXPk Property (ECC Control)

Holds the public key data.

Syntax

ecccontrol.SignerKeyXPk[=string]

Default Value

""

Remarks

Holds the public key data.

Note: This value is only applicable when using Curve25519 or Curve448.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyXPkB.

Data Type

Binary String

UseHex Property (ECC Control)

Whether binary values are hex encoded.

Syntax

ecccontrol.UseHex[=boolean]

Default Value

False

Remarks

This setting specifies whether various calculated values are hex encoded. If set to False (Default) all data is provided as-is with no encoding.

If set to True certain properties are hex encoded when populated for ease of display, transport, and storage.

Compute Secret Notes

This property specifies whether SharedSecret is hex encoded when ComputeSecret is called.

Sign and Verify Notes

This property specifies whether HashValue and HashSignature are hex encoded.

If set to True, when Sign is called the control will compute the hash for the specified file and populate HashValue with the hex encoded hash value. It will then create the hash signature and populate HashSignature with the hex encoded hash signature value. If HashValue is specified directly it must be a hex encoded value.

If set to True, when VerifySignature is called the control will compute the hash value for the specified file and populate HashValue with the hex encoded hash value. It will then hex decode HashSignature and verify the signature. HashSignature must hold a hex encoded value. If HashValue is specified directly it must be a hex encoded value.

Encrypt and Decrypt Notes

If set to True, when Encrypt is called the control will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.

If set to True, when Decrypt is called the control will expect InputMessage or InputFile to hold hex encoded data. The control will then hex decode the data and perform decryption as normal.

Data Type

Boolean

ComputeSecret Method (ECC Control)

Computes a shared secret.

Syntax

ecccontrol.ComputeSecret 

Remarks

This method computes a shared secret using Elliptic Curve Diffie Hellman (ECDH).

When this method is called the control will use the public key specified by RecipientKeyPublicKey and the private key specified by Key to compute a shared secret, or secret agreement. The ComputeSecretKDF property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by SharedSecret. The following properties are applicable when calling this method:

• Key (required)
• RecipientKeyPublicKey (required)
• ComputeSecretKDF (optional)

See ComputeSecretKDF for details on advanced settings that may be applicable for the chosen algorithm.

Keys created with the Ed25519 and Ed448 algorithms are not supported when calling this method.

Compute Secret Example

//Create a key for Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("X25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Create a key for Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("X25519"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Note: the public keys must be exchanged between parties by some mechanism //Create the shared secret on Party 1 ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; //Private key of this party ecc1.RecipientKey.PublicKey = ecc2_pub; //Public key of other party ecc1.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage ecc1.ComputeSecret(); Console.WriteLine(ecc1.SharedSecret); //Create the shared secret on Party 2 ecc2.Reset(); ecc2.Key.PrivateKey = ecc2_priv; //Private key of this party ecc2.RecipientKey.PublicKey = ecc1_pub; //Public key of other party ecc2.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage ecc2.ComputeSecret(); Console.WriteLine(ecc2.SharedSecret); //This will match the shared secret created by ecc1.

Config Method (ECC Control)

Sets or retrieves a configuration setting.

Syntax

ecccontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateKey Method (ECC Control)

Creates a new key.

Syntax

ecccontrol.CreateKey KeyAlgorithm

Remarks

CreateKey creates a new public and private key.

When this method is called Key is populated with the generated key. The KeyPublicKey and KeyPrivateKey property hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.

The KeyAlgorithm parameter specifies the algorithm for which the key is intended to be used. Possible values are:

NIST, Koblitz, and Brainpool Curve Notes

Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters.

The public key consists of the following parameters:

• KeyRx
• KeyRy

The private key consists of one value:

• KeyK

Curve25519 and Curve448 Notes

Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.

KeyXPk holds the public key.

KeyXSk holds the private key.

Create Key Example (secp256r1 - PEM)

//Create a key using secp256r1 Ecc ecc = new Ecc(); ecc.CreateKey("secp256r1"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1" string privKey = ecc.Key.PrivateKey; //PEM formatted key string pubKey = ecc.Key.PublicKey; //PEM formatted key //Load the saved key ecc.Reset(); ecc.Key.PublicKey = pubKey; ecc.Key.PrivateKey = privKey; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"

Create Key Example (secp256r1 - Raw Key Params)

//Create a key using secp256r1 and store/load the key using the individual params Ecc ecc = new Ecc(); ecc.CreateKey("secp256r1"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1" byte[] K = ecc.Key.KB; //Private key param byte[] Rx = ecc.Key.RxB; //Public key param byte[] Ry = ecc.Key.RyB; //Public key param //Load the saved key ecc.Reset(); ecc.Key.Algorithm = ECAlgorithms.eaSecp256r1; //This MUST be set manually when using key params directly ecc.Key.KB = K; ecc.Key.RxB = Rx; ecc.Key.RyB = Ry; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"

Create Key Example (Ed25519 - PEM)

//Create a key using Ed25519 Ecc ecc = new Ecc(); ecc.CreateKey("Ed25519"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519" string privKey = ecc.Key.PrivateKey; //PEM formatted key string pubKey = ecc.Key.PublicKey; //PEM formatted key //Load the saved key ecc.Reset(); ecc.Key.PublicKey = pubKey; ecc.Key.PrivateKey = privKey; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"

Create Key Example (Ed25519 - Raw Key Params)

//Create a key using Ed25519 and store/load the key using the individual params Ecc ecc = new Ecc(); ecc.CreateKey("Ed25519"); Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519" byte[] XPk = ecc.Key.XPkB; //Public key data byte[] XSk = ecc.Key.XSkB; //Secret key data //Load the saved key ecc.Reset(); ecc.Key.Algorithm = ECAlgorithms.eaEd25519; //This MUST be set manually when using key params directly ecc.Key.XPkB = XPk; ecc.Key.XSkB = XSk; Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"

Decrypt Method (ECC Control)

Decrypted the specified data.

Syntax

ecccontrol.Decrypt 

Remarks

Decrypt decrypts the specified data with the ECDSA private key specified in Key.

Decryption is performed using ECIES which requires an ECDSA key. Key must contain an ECDSA key. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

• NIST Curves (secp256r1, secp384r1, secp521r1)
• Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
• Brainpool Curves

See CreateKey for details about key creation and algorithms.

When this method is called the control will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set UseHex to True.

The following properties are applicable when calling this method:

• EncryptionAlgorithm
• HMACAlgorithm
• HMACOptionalInfo
• HMACKeySize
• IV
• KDF
• KDFHashAlgorithm
• KDFOptionalInfo
• UseHex

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Encrypt and Decrypt Example

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (AES with IV)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); //Use an IV (16 bytes for AES) - In a real environment this should be random byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F }; ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc1.IVB = IV; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message and the IV to Party 2 //Decrypt the message using the private key for Party 2 and the IV ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc2.IVB = IV; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (XOR Encryption Algorithm)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (KDF Options)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.KDF = "KDF1"; //Use KDF1 ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.KDF = "KDF1"; ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt Method (ECC Control)

Encrypts the specified data.

Syntax

ecccontrol.Encrypt 

Remarks

Encrypt encrypts the specified data with the ECDSA public key specified in RecipientKey.

Encryption is performed using ECIES which requires an ECDSA key. RecipientKey must contain an ECDSA key. Algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

• NIST Curves (secp256r1, secp384r1, secp521r1)
• Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
• Brainpool Curves

See CreateKey for details about key creation and algorithms.

When this method is called the control will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output set UseHex to True.

The following properties are applicable when calling this method:

• EncryptionAlgorithm
• HMACAlgorithm
• HMACOptionalInfo
• HMACKeySize
• IV
• KDF
• KDFHashAlgorithm
• KDFOptionalInfo
• UseHex

Input and Output Properties

The control will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputMessage

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Encrypt and Decrypt Example

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (AES with IV)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); //Use an IV (16 bytes for AES) - In a real environment this should be random byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F }; ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc1.IVB = IV; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message and the IV to Party 2 //Decrypt the message using the private key for Party 2 and the IV ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES; ecc2.IVB = IV; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (XOR Encryption Algorithm)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR; ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Encrypt and Decrypt Example (KDF Options)

//Create an ECDSA key on Party 2 Ecc ecc2 = new Ecc(); ecc2.CreateKey("secp256r1"); string ecc2_priv = ecc2.Key.PrivateKey; string ecc2_pub = ecc2.Key.PublicKey; //Transmit public key to Party 1 //Encrypt the message on Party 1 using public key from Party 2 Ecc ecc1 = new Ecc(); ecc1.KDF = "KDF1"; //Use KDF1 ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string ecc1.InputMessage = "hello ecc"; ecc1.RecipientKey.PublicKey = ecc2_pub; ecc1.UseHex = true; ecc1.Encrypt(); string encryptedMessage = ecc1.OutputMessage; //Transmit the encrypted message to Party 2 //Decrypt the message using the private key for Party 2 ecc2.KDF = "KDF1"; ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1; ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); ecc2.Key.PrivateKey = ecc2_priv; ecc2.InputMessage = encryptedMessage; ecc2.UseHex = true; ecc2.Decrypt(); Console.WriteLine(ecc2.OutputMessage);

Reset Method (ECC Control)

Resets the control.

Syntax

ecccontrol.Reset 

Remarks

When called, the control will reset all of its properties to their default values.

Sign Method (ECC Control)

Creates a hash signature using ECDSA or EdDSA.

Syntax

ecccontrol.Sign 

Remarks

Sign will create a hash signature using ECDSA or EdDSA. The control will use the key specified by Key to has the input data and sign the resulting hash.

Key must contain a private key created with a valid ECDSA or EdDSA algorithm. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for signing are:

• NIST Curves (secp256r1, secp384r1, secp521r1)
• Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
• Brainpool Curves
• Ed25519 and Ed448

See CreateKey for details about key creation and algorithms.

When this method is called data will be read from the InputFile or InputMessage.

The hash to be signed will be computed using the specified HashAlgorithm. The computed hash is stored in the HashValue property. The signed hash is stored in the HashSignature property.

To sign as hash without first computing it set HashValue to a previously computed hash for the input data. Note: HashValue is not applicable when signing with a PureEdDSA algorithm such as "Ed25519" or "Ed448".

The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.

After calling Sign the public key must be sent to the recipient along with HashSignature and original input data so the other party may perform signature verification.

The following properties are applicable when calling this method:

• Key (required)
• HashAlgorithm (applicable to ECDSA only)
• HashEdDSA (applicable to EdDSA only)
• HashValue (not applicable to PureEdDSA)
• UseHex

The following properties are populated after calling this method:

• HashValue
• HashSignature

EdDSA Notes

When the KeyAlgorithm is Ed25519 or Ed448 the following additional parameters are applicable:

• HashEdDSA
• EdDSAContext

EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or as HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the HashEdDSA property. By default the control uses the PureEdDSA algorithm.

The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA HashValue is not applicable.

When using a HashEdDSA algorithm the input is pre-hashed and supports a single pass over the data during the signing operation. To enable HashEdDSA set HashEdDSA to True.

To specify context data when using Ed25519 or Ed448 set EdDSAContext.

Sign And Verify Example (ECDSA)

//Create an ECDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("secp256r1"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - PureEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - HashEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.HashEdDSA = true; //Use "ed25519ph" ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.HashEdDSA = true; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

VerifySignature Method (ECC Control)

Verifies the signature for the specified data.

Syntax

ecccontrol.VerifySignature 

Remarks

VerifySignature will verify a hash signature and return True if successful or False otherwise.

Before calling this method specify the input file by setting InputFile or InputMessage.

A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Specify the hash signature in HashSignature.

When this method is called the control will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

To verify the hash signature without first computing the hash simply specify HashValue before calling this method. Note: HashValue is not applicable when the message was signed with a PureEdDSA algorithm such as Ed25519 or Ed448.

The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.

The following properties are applicable when calling this method:

• HashSignature (required)
• SignerKey (required)
• EdDSAContext (applicable to EdDSA only)
• HashAlgorithm (applicable to ECDSA only)
• HashEdDSA (applicable to EdDSA only)
• HashValue (not applicable to PureEdDSA)
• UseHex

Sign And Verify Example (ECDSA)

//Create an ECDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("secp256r1"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - PureEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Sign And Verify Example (EdDSA - HashEdDSA)

//Create an EdDSA key on Party 1 Ecc ecc1 = new Ecc(); ecc1.CreateKey("ed25519"); string ecc1_priv = ecc1.Key.PrivateKey; string ecc1_pub = ecc1.Key.PublicKey; //Sign the data on Party 1 string originalData = "hello ecc"; ecc1.Reset(); ecc1.Key.PrivateKey = ecc1_priv; ecc1.InputMessage = originalData; ecc1.UseHex = true; //Hex encode the hash signature for ease of use. ecc1.HashEdDSA = true; //Use "ed25519ph" ecc1.Sign(); string hashSignature = ecc1.HashSignature; //Transmit the hash signature, public key, and original data to part 2 //Verify the data on Party 2 Ecc ecc2 = new Ecc(); ecc2.SignerKey.PublicKey = ecc1_pub; ecc2.InputMessage = originalData; ecc2.HashSignature = hashSignature; ecc2.HashEdDSA = true; ecc2.UseHex = true; //Decode the hex encoded hash signature bool isVerified = ecc2.VerifySignature();

Error Event (ECC Control)

Information about errors during data delivery.

Syntax

Sub ecccontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (ECC Control)

Fired as progress is made.

Syntax

Sub ecccontrol_Progress(BytesProcessed As Long64, PercentProcessed As Integer)

Remarks

This event is fired automatically as data is processed by the control.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

Config Settings (ECC Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

ECC Config Settings

Base Config Settings

Trappable Errors (ECC Control)

ECC Errors

	20103    No Key specified.
	20105    Cannot read or write file.
	20112    OutputFile already exists and Overwrite is False.
	20121    Invalid curve.
	20125    HashSignature must be specified.
	20305    Cannot write file.
	20306    Cannot read file.
	20307    Cannot create file.
	21402    Specified ECC parameters are invalid.
	21403    Missing hash value.
	21404    Public key must be specified.
	21405    Key must be specified.
	21406    HashSignature must be specified.
	21407    Invalid key size.
	21408    Invalid TLS seed. TLSSeed must be 64 bytes long.
	21409    Invalid TLS label.
	21410    Unsupported key format.
	21411    Unsupported curve.