ECC Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipcECC

Remarks

The ECC (Elliptic Curve Cryptography) component implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The component 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 component is very flexible and offers many properties and configuration settings to configure it. The sections below detail the use of the component 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 properties 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 component 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 component will use the key specified by Key to hash 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 a 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 the 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 a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the HashEdDSA property. By default, the component uses the PureEdDSA algorithm.

The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that 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 Party 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 Party 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 Party 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 component 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 Party 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 Party 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 Party 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. 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 component 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 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

CertEffectiveDate Property (ECC Component)

This is the date on which this certificate becomes valid.

Syntax

__property String CertEffectiveDate = { read=FCertEffectiveDate };

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

CertExpirationDate Property (ECC Component)

This is the date the certificate expires.

Syntax

__property String CertExpirationDate = { read=FCertExpirationDate };

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

CertExtendedKeyUsage Property (ECC Component)

This is a comma-delimited list of extended key usage identifiers.

Syntax

__property String CertExtendedKeyUsage = { read=FCertExtendedKeyUsage };

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

CertFingerprint Property (ECC Component)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String CertFingerprint = { read=FCertFingerprint };

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

CertFingerprintSHA1 Property (ECC Component)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String CertFingerprintSHA1 = { read=FCertFingerprintSHA1 };

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

CertFingerprintSHA256 Property (ECC Component)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String CertFingerprintSHA256 = { read=FCertFingerprintSHA256 };

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

CertIssuer Property (ECC Component)

This is the issuer of the certificate.

Syntax

__property String CertIssuer = { read=FCertIssuer };

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

CertPrivateKey Property (ECC Component)

This is the private key of the certificate (if available).

Syntax

__property String CertPrivateKey = { read=FCertPrivateKey };

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (ECC Component)

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

__property bool CertPrivateKeyAvailable = { read=FCertPrivateKeyAvailable };

Default Value

false

Remarks

This property shows whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (ECC Component)

This is the name of the PrivateKey container for the certificate (if available).

Syntax

__property String CertPrivateKeyContainer = { read=FCertPrivateKeyContainer };

Default Value

""

Remarks

This is the name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

CertPublicKey Property (ECC Component)

This is the public key of the certificate.

Syntax

__property String CertPublicKey = { read=FCertPublicKey };

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

CertPublicKeyAlgorithm Property (ECC Component)

This property contains the textual description of the certificate's public key algorithm.

Syntax

__property String CertPublicKeyAlgorithm = { read=FCertPublicKeyAlgorithm };

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertPublicKeyLength Property (ECC Component)

This is the length of the certificate's public key (in bits).

Syntax

__property int CertPublicKeyLength = { read=FCertPublicKeyLength };

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

CertSerialNumber Property (ECC Component)

This is the serial number of the certificate encoded as a string.

Syntax

__property String CertSerialNumber = { read=FCertSerialNumber };

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

CertSignatureAlgorithm Property (ECC Component)

The property contains the text description of the certificate's signature algorithm.

Syntax

__property String CertSignatureAlgorithm = { read=FCertSignatureAlgorithm };

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertStore Property (ECC Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String CertStore = { read=FCertStore, write=FSetCertStore };
__property DynamicArray<Byte> CertStoreB = { read=FCertStoreB, write=FSetCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

Data Type

Byte Array

CertStorePassword Property (ECC Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String CertStorePassword = { read=FCertStorePassword, write=FSetCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (ECC Component)

This is the type of certificate store for this certificate.

Syntax

__property TipcECCCertStoreTypes CertStoreType = { read=FCertStoreType, write=FSetCertStoreType };

enum TipcECCCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubjectAltNames Property (ECC Component)

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

__property String CertSubjectAltNames = { read=FCertSubjectAltNames };

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (ECC Component)

This property contains the MD5 hash of the certificate.

Syntax

__property String CertThumbprintMD5 = { read=FCertThumbprintMD5 };

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (ECC Component)

This property contains the SHA-1 hash of the certificate.

Syntax

__property String CertThumbprintSHA1 = { read=FCertThumbprintSHA1 };

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (ECC Component)

This property contains the SHA-256 hash of the certificate.

Syntax

__property String CertThumbprintSHA256 = { read=FCertThumbprintSHA256 };

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertUsage Property (ECC Component)

This property contains the text description of UsageFlags .

Syntax

__property String CertUsage = { read=FCertUsage };

Default Value

""

Remarks

This property contains the text description of CertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

CertUsageFlags Property (ECC Component)

This property contains the flags that show intended use for the certificate.

Syntax

__property int CertUsageFlags = { read=FCertUsageFlags };

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:

Please see the CertUsage property for a text representation of CertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

CertVersion Property (ECC Component)

This property contains the certificate's version number.

Syntax

__property String CertVersion = { read=FCertVersion };

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

CertSubject Property (ECC Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String CertSubject = { read=FCertSubject, write=FSetCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

CertEncoded Property (ECC Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String CertEncoded = { read=FCertEncoded, write=FSetCertEncoded };
__property DynamicArray<Byte> CertEncodedB = { read=FCertEncodedB, write=FSetCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

ComputeSecretKDF Property (ECC Component)

The key derivation function.

Syntax

__property TipcECCComputeSecretKDFs ComputeSecretKDF = { read=FComputeSecretKDF, write=FSetComputeSecretKDF };

enum TipcECCComputeSecretKDFs {
  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

ekdSHA256

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 Component)

The encryption algorithm to use.

Syntax

__property TipcECCEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

enum TipcECCEncryptionAlgorithms {
  iesAES=0,
  iesTripleDES=1,
  iesXOR=2
};

Default Value

iesAES

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 Component)

The hash algorithm used for hash computation.

Syntax

__property TipcECCHashAlgorithms HashAlgorithm = { read=FHashAlgorithm, write=FSetHashAlgorithm };

enum TipcECCHashAlgorithms {
  ehaSHA1=0,
  ehaSHA224=1,
  ehaSHA256=2,
  ehaSHA384=3,
  ehaSHA512=4,
  ehaMD2=5,
  ehaMD4=6,
  ehaMD5=7,
  ehaMD5SHA1=8,
  ehaRIPEMD160=9
};

Default Value

ehaSHA256

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 specifies 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 Component)

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

Syntax

__property bool HashEdDSA = { read=FHashEdDSA, write=FSetHashEdDSA };

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 component 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 component 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 that 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 Component)

The hash signature.

Syntax

__property String HashSignature = { read=FHashSignature, write=FSetHashSignature };
__property DynamicArray<Byte> HashSignatureB = { read=FHashSignatureB, write=FSetHashSignatureB };

Default Value

""

Remarks

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

Data Type

Byte Array

HashValue Property (ECC Component)

The hash value of the data.

Syntax

__property String HashValue = { read=FHashValue, write=FSetHashValue };
__property DynamicArray<Byte> HashValueB = { read=FHashValueB, write=FSetHashValueB };

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 component, 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 used and HashValue is not applicable.

Hash Notes

The component 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 component 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.

Data Type

Byte Array

HMACAlgorithm Property (ECC Component)

The HMAC algorithm to use during encryption.

Syntax

__property TipcECCHMACAlgorithms HMACAlgorithm = { read=FHMACAlgorithm, write=FSetHMACAlgorithm };

enum TipcECCHMACAlgorithms {
  iesHMACSHA1=0,
  iesHMACSHA224=1,
  iesHMACSHA256=2,
  iesHMACSHA384=3,
  iesHMACSHA512=4,
  iesHMACRIPEMD160=5
};

Default Value

iesHMACSHA256

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 Component)

The file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

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 component 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 Component)

The message to process.

Syntax

__property String InputMessage = { read=FInputMessage, write=FSetInputMessage };
__property DynamicArray<Byte> InputMessageB = { read=FInputMessageB, write=FSetInputMessageB };

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The component 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

Byte Array

IV Property (ECC Component)

The initialization vector (IV) used when encrypting.

Syntax

__property String IV = { read=FIV, write=FSetIV };
__property DynamicArray<Byte> IVB = { read=FIVB, write=FSetIVB };

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 component 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.

Data Type

Byte Array

KDF Property (ECC Component)

The key derivation function used during encryption and decryption.

Syntax

__property String KDF = { read=FKDF, write=FSetKDF };

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 Component)

The KDF hash algorithm to use when encrypting and decrypting.

Syntax

__property TipcECCKDFHashAlgorithms KDFHashAlgorithm = { read=FKDFHashAlgorithm, write=FSetKDFHashAlgorithm };

enum TipcECCKDFHashAlgorithms {
  iesSHA1=0,
  iesSHA224=1,
  iesSHA256=2,
  iesSHA384=3,
  iesSHA512=4
};

Default Value

iesSHA256

Remarks

This property specifies the hash algorithm to use 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 Component)

This property holds the algorithm associated with the key.

Syntax

__property TipcECCKeyAlgorithms KeyAlgorithm = { read=FKeyAlgorithm, write=FSetKeyAlgorithm };

enum TipcECCKeyAlgorithms {
  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

eaSecp256r1

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 Component)

Represents the private key (K) parameter.

Syntax

__property String KeyK = { read=FKeyK, write=FSetKeyK };
__property DynamicArray<Byte> KeyKB = { read=FKeyKB, write=FSetKeyKB };

Default Value

""

Remarks

Represents the private key (K) parameter.

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

Data Type

Byte Array

KeyPrivateKey Property (ECC Component)

This property is a PEM formatted private key.

Syntax

__property String KeyPrivateKey = { read=FKeyPrivateKey, write=FSetKeyPrivateKey };

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 Component)

This property is a PEM formatted public key.

Syntax

__property String KeyPublicKey = { read=FKeyPublicKey, write=FSetKeyPublicKey };

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 Component)

Represents the public key's Rx parameter.

Syntax

__property String KeyRx = { read=FKeyRx, write=FSetKeyRx };
__property DynamicArray<Byte> KeyRxB = { read=FKeyRxB, write=FSetKeyRxB };

Default Value

""

Remarks

Represents the public key's Rx parameter.

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

Data Type

Byte Array

KeyRy Property (ECC Component)

Represents the public key's Ry parameter.

Syntax

__property String KeyRy = { read=FKeyRy, write=FSetKeyRy };
__property DynamicArray<Byte> KeyRyB = { read=FKeyRyB, write=FSetKeyRyB };

Default Value

""

Remarks

Represents the public key's Ry parameter.

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

Data Type

Byte Array

KeyXPk Property (ECC Component)

Holds the public key data.

Syntax

__property String KeyXPk = { read=FKeyXPk, write=FSetKeyXPk };
__property DynamicArray<Byte> KeyXPkB = { read=FKeyXPkB, write=FSetKeyXPkB };

Default Value

""

Remarks

Holds the public key data.

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

Data Type

Byte Array

KeyXSk Property (ECC Component)

Holds the private key data.

Syntax

__property String KeyXSk = { read=FKeyXSk, write=FSetKeyXSk };
__property DynamicArray<Byte> KeyXSkB = { read=FKeyXSkB, write=FSetKeyXSkB };

Default Value

""

Remarks

Holds the private key data.

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

Data Type

Byte Array

OutputFile Property (ECC Component)

The output file when encrypting or decrypting.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

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 component 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 Component)

The output message when encrypting or decrypting.

Syntax

__property String OutputMessage = { read=FOutputMessage };
__property DynamicArray<Byte> OutputMessageB = { read=FOutputMessageB };

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 component 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.

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

Data Type

Byte Array

Overwrite Property (ECC Component)

Indicates whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

This property indicates whether or not the component 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

RecipientCertEffectiveDate Property (ECC Component)

This is the date on which this certificate becomes valid.

Syntax

__property String RecipientCertEffectiveDate = { read=FRecipientCertEffectiveDate };

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

RecipientCertExpirationDate Property (ECC Component)

This is the date the certificate expires.

Syntax

__property String RecipientCertExpirationDate = { read=FRecipientCertExpirationDate };

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

RecipientCertExtendedKeyUsage Property (ECC Component)

This is a comma-delimited list of extended key usage identifiers.

Syntax

__property String RecipientCertExtendedKeyUsage = { read=FRecipientCertExtendedKeyUsage };

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

RecipientCertFingerprint Property (ECC Component)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String RecipientCertFingerprint = { read=FRecipientCertFingerprint };

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

RecipientCertFingerprintSHA1 Property (ECC Component)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String RecipientCertFingerprintSHA1 = { read=FRecipientCertFingerprintSHA1 };

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

RecipientCertFingerprintSHA256 Property (ECC Component)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String RecipientCertFingerprintSHA256 = { read=FRecipientCertFingerprintSHA256 };

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

RecipientCertIssuer Property (ECC Component)

This is the issuer of the certificate.

Syntax

__property String RecipientCertIssuer = { read=FRecipientCertIssuer };

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

RecipientCertPrivateKey Property (ECC Component)

This is the private key of the certificate (if available).

Syntax

__property String RecipientCertPrivateKey = { read=FRecipientCertPrivateKey };

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The RecipientCertPrivateKey may be available but not exportable. In this case, RecipientCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

RecipientCertPrivateKeyAvailable Property (ECC Component)

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

__property bool RecipientCertPrivateKeyAvailable = { read=FRecipientCertPrivateKeyAvailable };

Default Value

false

Remarks

This property shows whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

RecipientCertPrivateKeyContainer Property (ECC Component)

This is the name of the PrivateKey container for the certificate (if available).

Syntax

__property String RecipientCertPrivateKeyContainer = { read=FRecipientCertPrivateKeyContainer };

Default Value

""

Remarks

This is the name of the RecipientCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

RecipientCertPublicKey Property (ECC Component)

This is the public key of the certificate.

Syntax

__property String RecipientCertPublicKey = { read=FRecipientCertPublicKey };

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

RecipientCertPublicKeyAlgorithm Property (ECC Component)

This property contains the textual description of the certificate's public key algorithm.

Syntax

__property String RecipientCertPublicKeyAlgorithm = { read=FRecipientCertPublicKeyAlgorithm };

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

RecipientCertPublicKeyLength Property (ECC Component)

This is the length of the certificate's public key (in bits).

Syntax

__property int RecipientCertPublicKeyLength = { read=FRecipientCertPublicKeyLength };

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

RecipientCertSerialNumber Property (ECC Component)

This is the serial number of the certificate encoded as a string.

Syntax

__property String RecipientCertSerialNumber = { read=FRecipientCertSerialNumber };

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

RecipientCertSignatureAlgorithm Property (ECC Component)

The property contains the text description of the certificate's signature algorithm.

Syntax

__property String RecipientCertSignatureAlgorithm = { read=FRecipientCertSignatureAlgorithm };

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

RecipientCertStore Property (ECC Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String RecipientCertStore = { read=FRecipientCertStore, write=FSetRecipientCertStore };
__property DynamicArray<Byte> RecipientCertStoreB = { read=FRecipientCertStoreB, write=FSetRecipientCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

Data Type

Byte Array

RecipientCertStorePassword Property (ECC Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String RecipientCertStorePassword = { read=FRecipientCertStorePassword, write=FSetRecipientCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

RecipientCertStoreType Property (ECC Component)

This is the type of certificate store for this certificate.

Syntax

__property TipcECCRecipientCertStoreTypes RecipientCertStoreType = { read=FRecipientCertStoreType, write=FSetRecipientCertStoreType };

enum TipcECCRecipientCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

RecipientCertSubjectAltNames Property (ECC Component)

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

__property String RecipientCertSubjectAltNames = { read=FRecipientCertSubjectAltNames };

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

RecipientCertThumbprintMD5 Property (ECC Component)

This property contains the MD5 hash of the certificate.

Syntax

__property String RecipientCertThumbprintMD5 = { read=FRecipientCertThumbprintMD5 };

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertThumbprintSHA1 Property (ECC Component)

This property contains the SHA-1 hash of the certificate.

Syntax

__property String RecipientCertThumbprintSHA1 = { read=FRecipientCertThumbprintSHA1 };

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertThumbprintSHA256 Property (ECC Component)

This property contains the SHA-256 hash of the certificate.

Syntax

__property String RecipientCertThumbprintSHA256 = { read=FRecipientCertThumbprintSHA256 };

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertUsage Property (ECC Component)

This property contains the text description of UsageFlags .

Syntax

__property String RecipientCertUsage = { read=FRecipientCertUsage };

Default Value

""

Remarks

This property contains the text description of RecipientCertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

RecipientCertUsageFlags Property (ECC Component)

This property contains the flags that show intended use for the certificate.

Syntax

__property int RecipientCertUsageFlags = { read=FRecipientCertUsageFlags };

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of RecipientCertUsageFlags is a combination of the following flags:

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

RecipientCertVersion Property (ECC Component)

This property contains the certificate's version number.

Syntax

__property String RecipientCertVersion = { read=FRecipientCertVersion };

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

RecipientCertSubject Property (ECC Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String RecipientCertSubject = { read=FRecipientCertSubject, write=FSetRecipientCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

RecipientCertEncoded Property (ECC Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String RecipientCertEncoded = { read=FRecipientCertEncoded, write=FSetRecipientCertEncoded };
__property DynamicArray<Byte> RecipientCertEncodedB = { read=FRecipientCertEncodedB, write=FSetRecipientCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

RecipientKeyAlgorithm Property (ECC Component)

This property holds the algorithm associated with the key.

Syntax

__property TipcECCRecipientKeyAlgorithms RecipientKeyAlgorithm = { read=FRecipientKeyAlgorithm, write=FSetRecipientKeyAlgorithm };

enum TipcECCRecipientKeyAlgorithms {
  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

eaSecp256r1

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 Component)

This property is a PEM formatted public key.

Syntax

__property String RecipientKeyPublicKey = { read=FRecipientKeyPublicKey, write=FSetRecipientKeyPublicKey };

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 Component)

Represents the public key's Rx parameter.

Syntax

__property String RecipientKeyRx = { read=FRecipientKeyRx, write=FSetRecipientKeyRx };
__property DynamicArray<Byte> RecipientKeyRxB = { read=FRecipientKeyRxB, write=FSetRecipientKeyRxB };

Default Value

""

Remarks

Represents the public key's Rx parameter.

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

Data Type

Byte Array

RecipientKeyRy Property (ECC Component)

Represents the public key's Ry parameter.

Syntax

__property String RecipientKeyRy = { read=FRecipientKeyRy, write=FSetRecipientKeyRy };
__property DynamicArray<Byte> RecipientKeyRyB = { read=FRecipientKeyRyB, write=FSetRecipientKeyRyB };

Default Value

""

Remarks

Represents the public key's Ry parameter.

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

Data Type

Byte Array

RecipientKeyXPk Property (ECC Component)

Holds the public key data.

Syntax

__property String RecipientKeyXPk = { read=FRecipientKeyXPk, write=FSetRecipientKeyXPk };
__property DynamicArray<Byte> RecipientKeyXPkB = { read=FRecipientKeyXPkB, write=FSetRecipientKeyXPkB };

Default Value

""

Remarks

Holds the public key data.

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

Data Type

Byte Array

SharedSecret Property (ECC Component)

The computed shared secret.

Syntax

__property String SharedSecret = { read=FSharedSecret };
__property DynamicArray<Byte> SharedSecretB = { read=FSharedSecretB };

Default Value

""

Remarks

This property holds the shared secret computed by ComputeSecret.

This property is read-only.

Data Type

Byte Array

SignerCertEffectiveDate Property (ECC Component)

This is the date on which this certificate becomes valid.

Syntax

__property String SignerCertEffectiveDate = { read=FSignerCertEffectiveDate };

Default Value

""

Remarks

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SignerCertExpirationDate Property (ECC Component)

This is the date the certificate expires.

Syntax

__property String SignerCertExpirationDate = { read=FSignerCertExpirationDate };

Default Value

""

Remarks

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SignerCertExtendedKeyUsage Property (ECC Component)

This is a comma-delimited list of extended key usage identifiers.

Syntax

__property String SignerCertExtendedKeyUsage = { read=FSignerCertExtendedKeyUsage };

Default Value

""

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SignerCertFingerprint Property (ECC Component)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SignerCertFingerprint = { read=FSignerCertFingerprint };

Default Value

""

Remarks

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SignerCertFingerprintSHA1 Property (ECC Component)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SignerCertFingerprintSHA1 = { read=FSignerCertFingerprintSHA1 };

Default Value

""

Remarks

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SignerCertFingerprintSHA256 Property (ECC Component)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SignerCertFingerprintSHA256 = { read=FSignerCertFingerprintSHA256 };

Default Value

""

Remarks

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SignerCertIssuer Property (ECC Component)

This is the issuer of the certificate.

Syntax

__property String SignerCertIssuer = { read=FSignerCertIssuer };

Default Value

""

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SignerCertPrivateKey Property (ECC Component)

This is the private key of the certificate (if available).

Syntax

__property String SignerCertPrivateKey = { read=FSignerCertPrivateKey };

Default Value

""

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SignerCertPrivateKeyAvailable Property (ECC Component)

This property shows whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SignerCertPrivateKeyAvailable = { read=FSignerCertPrivateKeyAvailable };

Default Value

false

Remarks

This property shows whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SignerCertPrivateKeyContainer Property (ECC Component)

This is the name of the PrivateKey container for the certificate (if available).

Syntax

__property String SignerCertPrivateKeyContainer = { read=FSignerCertPrivateKeyContainer };

Default Value

""

Remarks

This is the name of the SignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SignerCertPublicKey Property (ECC Component)

This is the public key of the certificate.

Syntax

__property String SignerCertPublicKey = { read=FSignerCertPublicKey };

Default Value

""

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SignerCertPublicKeyAlgorithm Property (ECC Component)

This property contains the textual description of the certificate's public key algorithm.

Syntax

__property String SignerCertPublicKeyAlgorithm = { read=FSignerCertPublicKeyAlgorithm };

Default Value

""

Remarks

This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SignerCertPublicKeyLength Property (ECC Component)

This is the length of the certificate's public key (in bits).

Syntax

__property int SignerCertPublicKeyLength = { read=FSignerCertPublicKeyLength };

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SignerCertSerialNumber Property (ECC Component)

This is the serial number of the certificate encoded as a string.

Syntax

__property String SignerCertSerialNumber = { read=FSignerCertSerialNumber };

Default Value

""

Remarks

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SignerCertSignatureAlgorithm Property (ECC Component)

The property contains the text description of the certificate's signature algorithm.

Syntax

__property String SignerCertSignatureAlgorithm = { read=FSignerCertSignatureAlgorithm };

Default Value

""

Remarks

The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SignerCertStore Property (ECC Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SignerCertStore = { read=FSignerCertStore, write=FSetSignerCertStore };
__property DynamicArray<Byte> SignerCertStoreB = { read=FSignerCertStoreB, write=FSetSignerCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).

Data Type

Byte Array

SignerCertStorePassword Property (ECC Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SignerCertStorePassword = { read=FSignerCertStorePassword, write=FSetSignerCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SignerCertStoreType Property (ECC Component)

This is the type of certificate store for this certificate.

Syntax

__property TipcECCSignerCertStoreTypes SignerCertStoreType = { read=FSignerCertStoreType, write=FSetSignerCertStoreType };

enum TipcECCSignerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubjectAltNames Property (ECC Component)

This property contains comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SignerCertSubjectAltNames = { read=FSignerCertSubjectAltNames };

Default Value

""

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SignerCertThumbprintMD5 Property (ECC Component)

This property contains the MD5 hash of the certificate.

Syntax

__property String SignerCertThumbprintMD5 = { read=FSignerCertThumbprintMD5 };

Default Value

""

Remarks

This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA1 Property (ECC Component)

This property contains the SHA-1 hash of the certificate.

Syntax

__property String SignerCertThumbprintSHA1 = { read=FSignerCertThumbprintSHA1 };

Default Value

""

Remarks

This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA256 Property (ECC Component)

This property contains the SHA-256 hash of the certificate.

Syntax

__property String SignerCertThumbprintSHA256 = { read=FSignerCertThumbprintSHA256 };

Default Value

""

Remarks

This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertUsage Property (ECC Component)

This property contains the text description of UsageFlags .

Syntax

__property String SignerCertUsage = { read=FSignerCertUsage };

Default Value

""

Remarks

This property contains the text description of SignerCertUsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SignerCertUsageFlags Property (ECC Component)

This property contains the flags that show intended use for the certificate.

Syntax

__property int SignerCertUsageFlags = { read=FSignerCertUsageFlags };

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SignerCertVersion Property (ECC Component)

This property contains the certificate's version number.

Syntax

__property String SignerCertVersion = { read=FSignerCertVersion };

Default Value

""

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SignerCertSubject Property (ECC Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SignerCertSubject = { read=FSignerCertSubject, write=FSetSignerCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SignerCertEncoded Property (ECC Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SignerCertEncoded = { read=FSignerCertEncoded, write=FSetSignerCertEncoded };
__property DynamicArray<Byte> SignerCertEncodedB = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SignerKeyAlgorithm Property (ECC Component)

This property holds the algorithm associated with the key.

Syntax

__property TipcECCSignerKeyAlgorithms SignerKeyAlgorithm = { read=FSignerKeyAlgorithm, write=FSetSignerKeyAlgorithm };

enum TipcECCSignerKeyAlgorithms {
  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

eaSecp256r1

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 Component)

This property is a PEM formatted public key.

Syntax

__property String SignerKeyPublicKey = { read=FSignerKeyPublicKey, write=FSetSignerKeyPublicKey };

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 Component)

Represents the public key's Rx parameter.

Syntax

__property String SignerKeyRx = { read=FSignerKeyRx, write=FSetSignerKeyRx };
__property DynamicArray<Byte> SignerKeyRxB = { read=FSignerKeyRxB, write=FSetSignerKeyRxB };

Default Value

""

Remarks

Represents the public key's Rx parameter.

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

Data Type

Byte Array

SignerKeyRy Property (ECC Component)

Represents the public key's Ry parameter.

Syntax

__property String SignerKeyRy = { read=FSignerKeyRy, write=FSetSignerKeyRy };
__property DynamicArray<Byte> SignerKeyRyB = { read=FSignerKeyRyB, write=FSetSignerKeyRyB };

Default Value

""

Remarks

Represents the public key's Ry parameter.

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

Data Type

Byte Array

SignerKeyXPk Property (ECC Component)

Holds the public key data.

Syntax

__property String SignerKeyXPk = { read=FSignerKeyXPk, write=FSetSignerKeyXPk };
__property DynamicArray<Byte> SignerKeyXPkB = { read=FSignerKeyXPkB, write=FSetSignerKeyXPkB };

Default Value

""

Remarks

Holds the public key data.

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

Data Type

Byte Array

UseHex Property (ECC Component)

Whether binary values are hex encoded.

Syntax

__property bool UseHex = { read=FUseHex, write=FSetUseHex };

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 component 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 component 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 component 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 component will expect InputMessage or InputFile to hold hex encoded data. The component will then hex decode the data and perform decryption as normal.

Data Type

Boolean

ComputeSecret Method (ECC Component)

Computes a shared secret.

Syntax

void __fastcall ComputeSecret();

Remarks

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

When this method is called, the component 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 Component)

This method sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Creates a new key.

Syntax

void __fastcall CreateKey(String 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 properties 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 Component)

Decrypted the specified data.

Syntax

void __fastcall 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 component 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 component 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 Component)

Encrypts the specified data.

Syntax

void __fastcall 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. 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 component 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 component 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 Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

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

Sign Method (ECC Component)

Creates a hash signature using ECDSA or EdDSA.

Syntax

void __fastcall Sign();

Remarks

Sign will create a hash signature using ECDSA or EdDSA. The component will use the key specified by Key to hash 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 a 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 the 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 a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the HashEdDSA property. By default, the component uses the PureEdDSA algorithm.

The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that 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 Party 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 Party 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 Party 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 Component)

Verifies the signature for the specified data.

Syntax

bool __fastcall 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 component 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 Party 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 Party 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 Party 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 Component)

This event is fired for information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipcECCErrorEventParams;
typedef void __fastcall (__closure *TipcECCErrorEvent)(System::TObject* Sender, TipcECCErrorEventParams *e);
__property TipcECCErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 Component)

Fired as progress is made.

Syntax

typedef struct {
  __int64 BytesProcessed;
  int PercentProcessed;
} TipcECCProgressEventParams;
typedef void __fastcall (__closure *TipcECCProgressEvent)(System::TObject* Sender, TipcECCProgressEventParams *e);
__property TipcECCProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

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

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 Component)

The component 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 component, access to these internal properties is provided through the Config method.

ECC Config Settings

Base Config Settings

Trappable Errors (ECC Component)

ECC Errors