ECC Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ECC

Remarks

The ECC (Elliptic Curve Cryptography) class implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), and ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The class 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 class is very flexible and offers many properties and configuration settings to configure the class. The sections below detail the use of the class for each of the major operations listed above.

Key Creation and Management

CreateKey creates a new public and private key.

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

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

NIST, Koblitz, and Brainpool Curve Notes

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

The public key consists of the following parameters:

• KeyRx
• KeyRy

The private key consists of one value:

• KeyK

Curve25519 and Curve448 Notes

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

KeyXPk holds the public key.

KeyXSk holds the private key.

Create Key Example (secp256r1 - PEM)

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

Create Key Example (secp256r1 - Raw Key Params)

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

Create Key Example (Ed25519 - PEM)

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

Create Key Example (Ed25519 - Raw Key Params)

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

Compute Secret (ECDH)

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

When this method is called the class 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 class will use the key specified by Key to has the input data and sign the resulting hash.

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

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

See CreateKey for details about key creation and algorithms.

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

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

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

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

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

The following properties are applicable when calling this method:

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

The following properties are populated after calling this method:

• HashValue
• HashSignature

EdDSA Notes

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

• HashEdDSA
• EdDSAContext

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

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

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

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

Verifying (ECDSA and EdDSA)

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

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

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

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

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

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

The following properties are applicable when calling this method:

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

Encrypting (ECIES)

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

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

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

See CreateKey for details about key creation and algorithms.

When this method is called the class 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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 class 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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ComputeSecretKDF Property (ECC Class)

The key derivation function.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetComputeSecretKDF();
int SetComputeSecretKDF(int iComputeSecretKDF);

Unicode (Windows)
INT GetComputeSecretKDF();
INT SetComputeSecretKDF(INT iComputeSecretKDF);

EKD_SHA1(0), 
EKD_SHA256(1), 
EKD_SHA384(2), 
EKD_SHA512(3), 
EKD_MD2(4), 
EKD_MD4(5), 
EKD_MD5(6), 
EKD_HMACSHA1(7), 
EKD_HMACSHA256(8), 
EKD_HMACSHA384(9), 
EKD_HMACSHA512(10), 
EKD_HMACMD5(11), 
EKD_TLS(12), 
EKD_CONCAT(13)

int ipworksencrypt_ecc_getcomputesecretkdf(void* lpObj);
int ipworksencrypt_ecc_setcomputesecretkdf(void* lpObj, int iComputeSecretKDF);

int GetComputeSecretKDF();
int SetComputeSecretKDF(int iComputeSecretKDF);

Default Value

1

Remarks

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

Possible values are:

HMAC Notes

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

TLS Notes

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

Concat Notes

If Concat is selected the following configuration settings are applicable:

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

Data Type

Integer

EncryptionAlgorithm Property (ECC Class)

The encryption algorithm to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

IES_AES(0), 
IES_TRIPLE_DES(1), 
IES_XOR(2)

int ipworksencrypt_ecc_getencryptionalgorithm(void* lpObj);
int ipworksencrypt_ecc_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

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

Possible values are:

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

AES Notes

Data Type

Integer

HashAlgorithm Property (ECC Class)

The hash algorithm used for hash computation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashAlgorithm();
int SetHashAlgorithm(int iHashAlgorithm);

Unicode (Windows)
INT GetHashAlgorithm();
INT SetHashAlgorithm(INT iHashAlgorithm);

EHA_SHA1(0), 
EHA_SHA224(1), 
EHA_SHA256(2), 
EHA_SHA384(3), 
EHA_SHA512(4), 
EHA_MD2(5), 
EHA_MD4(6), 
EHA_MD5(7), 
EHA_MD5SHA1(8), 
EHA_RIPEMD160(9)

int ipworksencrypt_ecc_gethashalgorithm(void* lpObj);
int ipworksencrypt_ecc_sethashalgorithm(void* lpObj, int iHashAlgorithm);

int GetHashAlgorithm();
int SetHashAlgorithm(int iHashAlgorithm);

Default Value

2

Remarks

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

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

Data Type

Integer

HashEdDSA Property (ECC Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashEdDSA();
int SetHashEdDSA(int bHashEdDSA);

Unicode (Windows)
BOOL GetHashEdDSA();
INT SetHashEdDSA(BOOL bHashEdDSA);

int ipworksencrypt_ecc_gethasheddsa(void* lpObj);
int ipworksencrypt_ecc_sethasheddsa(void* lpObj, int bHashEdDSA);

bool GetHashEdDSA();
int SetHashEdDSA(bool bHashEdDSA);

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 class 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 class will use the PureEdDSA algorithm (Ed25519 or Ed448) when signing. The PureEdDSA requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means even if it is feasible to compute collisions for the hash function, the algorithm is still secure.

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

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

Data Type

Boolean

HashSignature Property (ECC Class)

The hash signature.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashSignature(char* &lpHashSignature, int &lenHashSignature);
int SetHashSignature(const char* lpHashSignature, int lenHashSignature);

Unicode (Windows)
INT GetHashSignature(LPSTR &lpHashSignature, INT &lenHashSignature);
INT SetHashSignature(LPCSTR lpHashSignature, INT lenHashSignature);

int ipworksencrypt_ecc_gethashsignature(void* lpObj, char** lpHashSignature, int* lenHashSignature);
int ipworksencrypt_ecc_sethashsignature(void* lpObj, const char* lpHashSignature, int lenHashSignature);

QByteArray GetHashSignature();
int SetHashSignature(QByteArray qbaHashSignature);

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

Binary String

HashValue Property (ECC Class)

The hash value of the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHashValue(char* &lpHashValue, int &lenHashValue);
int SetHashValue(const char* lpHashValue, int lenHashValue);

Unicode (Windows)
INT GetHashValue(LPSTR &lpHashValue, INT &lenHashValue);
INT SetHashValue(LPCSTR lpHashValue, INT lenHashValue);

int ipworksencrypt_ecc_gethashvalue(void* lpObj, char** lpHashValue, int* lenHashValue);
int ipworksencrypt_ecc_sethashvalue(void* lpObj, const char* lpHashValue, int lenHashValue);

QByteArray GetHashValue();
int SetHashValue(QByteArray qbaHashValue);

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 class you may specify the pre-computed hash value here.

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

Hash Notes

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

Binary String

HMACAlgorithm Property (ECC Class)

The HMAC algorithm to use during encryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHMACAlgorithm();
int SetHMACAlgorithm(int iHMACAlgorithm);

Unicode (Windows)
INT GetHMACAlgorithm();
INT SetHMACAlgorithm(INT iHMACAlgorithm);

IES_HMACSHA1(0), 
IES_HMACSHA224(1), 
IES_HMACSHA256(2), 
IES_HMACSHA384(3), 
IES_HMACSHA512(4), 
IES_HMACRIPEMD160(5)

int ipworksencrypt_ecc_gethmacalgorithm(void* lpObj);
int ipworksencrypt_ecc_sethmacalgorithm(void* lpObj, int iHMACAlgorithm);

int GetHMACAlgorithm();
int SetHMACAlgorithm(int iHMACAlgorithm);

Default Value

2

Remarks

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

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

This property is only applicable when calling Encrypt or Decrypt.

Data Type

Integer

InputFile Property (ECC Class)

The file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksencrypt_ecc_getinputfile(void* lpObj);
int ipworksencrypt_ecc_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

String

InputMessage Property (ECC Class)

The message to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage);

Unicode (Windows)
INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);

int ipworksencrypt_ecc_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_ecc_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);

QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

Binary String

IV Property (ECC Class)

The initialization vector (IV) used when encrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIV(char* &lpIV, int &lenIV);
int SetIV(const char* lpIV, int lenIV);

Unicode (Windows)
INT GetIV(LPSTR &lpIV, INT &lenIV);
INT SetIV(LPCSTR lpIV, INT lenIV);

int ipworksencrypt_ecc_getiv(void* lpObj, char** lpIV, int* lenIV);
int ipworksencrypt_ecc_setiv(void* lpObj, const char* lpIV, int lenIV);

QByteArray GetIV();
int SetIV(QByteArray qbaIV);

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 class 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

Binary String

KDF Property (ECC Class)

The key derivation function used during encryption and decryption.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKDF();
int SetKDF(const char* lpszKDF);

Unicode (Windows)
LPWSTR GetKDF();
INT SetKDF(LPCWSTR lpszKDF);

char* ipworksencrypt_ecc_getkdf(void* lpObj);
int ipworksencrypt_ecc_setkdf(void* lpObj, const char* lpszKDF);

QString GetKDF();
int SetKDF(QString qsKDF);

Default Value

"KDF2"

Remarks

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

• "KDF1"
• "KDF2" (Default)

This property is only applicable when calling Encrypt or Decrypt.

Data Type

String

KDFHashAlgorithm Property (ECC Class)

The KDF hash algorithm to use when encrypting and decrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKDFHashAlgorithm();
int SetKDFHashAlgorithm(int iKDFHashAlgorithm);

Unicode (Windows)
INT GetKDFHashAlgorithm();
INT SetKDFHashAlgorithm(INT iKDFHashAlgorithm);

IES_SHA1(0), 
IES_SHA224(1), 
IES_SHA256(2), 
IES_SHA384(3), 
IES_SHA512(4)

int ipworksencrypt_ecc_getkdfhashalgorithm(void* lpObj);
int ipworksencrypt_ecc_setkdfhashalgorithm(void* lpObj, int iKDFHashAlgorithm);

int GetKDFHashAlgorithm();
int SetKDFHashAlgorithm(int iKDFHashAlgorithm);

Default Value

2

Remarks

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

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

This property is only applicable when calling Encrypt or Decrypt.

Data Type

Integer

KeyAlgorithm Property (ECC Class)

This property holds the algorithm associated with the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyAlgorithm();
int SetKeyAlgorithm(int iKeyAlgorithm);

Unicode (Windows)
INT GetKeyAlgorithm();
INT SetKeyAlgorithm(INT iKeyAlgorithm);

EA_SECP_256R_1(0), 
EA_SECP_384R_1(1), 
EA_SECP_521R_1(2), 
EA_ED_25519(3), 
EA_ED_448(4), 
EA_X25519(5), 
EA_X448(6), 
EA_SECP_160K_1(7), 
EA_SECP_192K_1(8), 
EA_SECP_224K_1(9), 
EA_SECP_256K_1(10), 
EA_BRAINPOOL_P160R_1(11), 
EA_BRAINPOOL_P192R_1(12), 
EA_BRAINPOOL_P224R_1(13), 
EA_BRAINPOOL_P256R_1(14), 
EA_BRAINPOOL_P320R_1(15), 
EA_BRAINPOOL_P384R_1(16), 
EA_BRAINPOOL_P512R_1(17), 
EA_BRAINPOOL_P160T_1(18), 
EA_BRAINPOOL_P192T_1(19), 
EA_BRAINPOOL_P224T_1(20), 
EA_BRAINPOOL_P256T_1(21), 
EA_BRAINPOOL_P320T_1(22), 
EA_BRAINPOOL_P384T_1(23), 
EA_BRAINPOOL_P512T_1(24)

int ipworksencrypt_ecc_getkeyalgorithm(void* lpObj);
int ipworksencrypt_ecc_setkeyalgorithm(void* lpObj, int iKeyAlgorithm);

int GetKeyAlgorithm();
int SetKeyAlgorithm(int iKeyAlgorithm);

Default Value

0

Remarks

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

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

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

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

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

Data Type

Integer

KeyK Property (ECC Class)

Represent the private key (K) parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyK(char* &lpKeyK, int &lenKeyK);
int SetKeyK(const char* lpKeyK, int lenKeyK);

Unicode (Windows)
INT GetKeyK(LPSTR &lpKeyK, INT &lenKeyK);
INT SetKeyK(LPCSTR lpKeyK, INT lenKeyK);

int ipworksencrypt_ecc_getkeyk(void* lpObj, char** lpKeyK, int* lenKeyK);
int ipworksencrypt_ecc_setkeyk(void* lpObj, const char* lpKeyK, int lenKeyK);

QByteArray GetKeyK();
int SetKeyK(QByteArray qbaKeyK);

Default Value

""

Remarks

Represent the private key (K) parameter.

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

Data Type

Binary String

KeyPrivateKey Property (ECC Class)

This property is a PEM formatted private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPrivateKey();
int SetKeyPrivateKey(const char* lpszKeyPrivateKey);

Unicode (Windows)
LPWSTR GetKeyPrivateKey();
INT SetKeyPrivateKey(LPCWSTR lpszKeyPrivateKey);

char* ipworksencrypt_ecc_getkeyprivatekey(void* lpObj);
int ipworksencrypt_ecc_setkeyprivatekey(void* lpObj, const char* lpszKeyPrivateKey);

QString GetKeyPrivateKey();
int SetKeyPrivateKey(QString qsKeyPrivateKey);

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

This property is a PEM formatted public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPublicKey();
int SetKeyPublicKey(const char* lpszKeyPublicKey);

Unicode (Windows)
LPWSTR GetKeyPublicKey();
INT SetKeyPublicKey(LPCWSTR lpszKeyPublicKey);

char* ipworksencrypt_ecc_getkeypublickey(void* lpObj);
int ipworksencrypt_ecc_setkeypublickey(void* lpObj, const char* lpszKeyPublicKey);

QString GetKeyPublicKey();
int SetKeyPublicKey(QString qsKeyPublicKey);

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

Represents the public key's Rx parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRx(char* &lpKeyRx, int &lenKeyRx);
int SetKeyRx(const char* lpKeyRx, int lenKeyRx);

Unicode (Windows)
INT GetKeyRx(LPSTR &lpKeyRx, INT &lenKeyRx);
INT SetKeyRx(LPCSTR lpKeyRx, INT lenKeyRx);

int ipworksencrypt_ecc_getkeyrx(void* lpObj, char** lpKeyRx, int* lenKeyRx);
int ipworksencrypt_ecc_setkeyrx(void* lpObj, const char* lpKeyRx, int lenKeyRx);

QByteArray GetKeyRx();
int SetKeyRx(QByteArray qbaKeyRx);

Default Value

""

Remarks

Represents the public key's Rx parameter.

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

Data Type

Binary String

KeyRy Property (ECC Class)

Represents the public key's Ry parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyRy(char* &lpKeyRy, int &lenKeyRy);
int SetKeyRy(const char* lpKeyRy, int lenKeyRy);

Unicode (Windows)
INT GetKeyRy(LPSTR &lpKeyRy, INT &lenKeyRy);
INT SetKeyRy(LPCSTR lpKeyRy, INT lenKeyRy);

int ipworksencrypt_ecc_getkeyry(void* lpObj, char** lpKeyRy, int* lenKeyRy);
int ipworksencrypt_ecc_setkeyry(void* lpObj, const char* lpKeyRy, int lenKeyRy);

QByteArray GetKeyRy();
int SetKeyRy(QByteArray qbaKeyRy);

Default Value

""

Remarks

Represents the public key's Ry parameter.

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

Data Type

Binary String

KeyXPk Property (ECC Class)

Holds the public key data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyXPk(char* &lpKeyXPk, int &lenKeyXPk);
int SetKeyXPk(const char* lpKeyXPk, int lenKeyXPk);

Unicode (Windows)
INT GetKeyXPk(LPSTR &lpKeyXPk, INT &lenKeyXPk);
INT SetKeyXPk(LPCSTR lpKeyXPk, INT lenKeyXPk);

int ipworksencrypt_ecc_getkeyxpk(void* lpObj, char** lpKeyXPk, int* lenKeyXPk);
int ipworksencrypt_ecc_setkeyxpk(void* lpObj, const char* lpKeyXPk, int lenKeyXPk);

QByteArray GetKeyXPk();
int SetKeyXPk(QByteArray qbaKeyXPk);

Default Value

""

Remarks

Holds the public key data.

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

Data Type

Binary String

KeyXSk Property (ECC Class)

Holds the private key data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeyXSk(char* &lpKeyXSk, int &lenKeyXSk);
int SetKeyXSk(const char* lpKeyXSk, int lenKeyXSk);

Unicode (Windows)
INT GetKeyXSk(LPSTR &lpKeyXSk, INT &lenKeyXSk);
INT SetKeyXSk(LPCSTR lpKeyXSk, INT lenKeyXSk);

int ipworksencrypt_ecc_getkeyxsk(void* lpObj, char** lpKeyXSk, int* lenKeyXSk);
int ipworksencrypt_ecc_setkeyxsk(void* lpObj, const char* lpKeyXSk, int lenKeyXSk);

QByteArray GetKeyXSk();
int SetKeyXSk(QByteArray qbaKeyXSk);

Default Value

""

Remarks

Holds the private key data.

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

Data Type

Binary String

OutputFile Property (ECC Class)

The output file when encrypting or decrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworksencrypt_ecc_getoutputfile(void* lpObj);
int ipworksencrypt_ecc_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

String

OutputMessage Property (ECC Class)

The output message when encrypting or decrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage);

Unicode (Windows)
INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);

int ipworksencrypt_ecc_getoutputmessage(void* lpObj, char** lpOutputMessage, int* lenOutputMessage);

QByteArray GetOutputMessage();

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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Data Type

Binary String

Overwrite Property (ECC Class)

Indicates whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworksencrypt_ecc_getoverwrite(void* lpObj);
int ipworksencrypt_ecc_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

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

Data Type

Boolean

RecipientKeyAlgorithm Property (ECC Class)

This property holds the algorithm associated with the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyAlgorithm();
int SetRecipientKeyAlgorithm(int iRecipientKeyAlgorithm);

Unicode (Windows)
INT GetRecipientKeyAlgorithm();
INT SetRecipientKeyAlgorithm(INT iRecipientKeyAlgorithm);

EA_SECP_256R_1(0), 
EA_SECP_384R_1(1), 
EA_SECP_521R_1(2), 
EA_ED_25519(3), 
EA_ED_448(4), 
EA_X25519(5), 
EA_X448(6), 
EA_SECP_160K_1(7), 
EA_SECP_192K_1(8), 
EA_SECP_224K_1(9), 
EA_SECP_256K_1(10), 
EA_BRAINPOOL_P160R_1(11), 
EA_BRAINPOOL_P192R_1(12), 
EA_BRAINPOOL_P224R_1(13), 
EA_BRAINPOOL_P256R_1(14), 
EA_BRAINPOOL_P320R_1(15), 
EA_BRAINPOOL_P384R_1(16), 
EA_BRAINPOOL_P512R_1(17), 
EA_BRAINPOOL_P160T_1(18), 
EA_BRAINPOOL_P192T_1(19), 
EA_BRAINPOOL_P224T_1(20), 
EA_BRAINPOOL_P256T_1(21), 
EA_BRAINPOOL_P320T_1(22), 
EA_BRAINPOOL_P384T_1(23), 
EA_BRAINPOOL_P512T_1(24)

int ipworksencrypt_ecc_getrecipientkeyalgorithm(void* lpObj);
int ipworksencrypt_ecc_setrecipientkeyalgorithm(void* lpObj, int iRecipientKeyAlgorithm);

int GetRecipientKeyAlgorithm();
int SetRecipientKeyAlgorithm(int iRecipientKeyAlgorithm);

Default Value

0

Remarks

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

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

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

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

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

Data Type

Integer

RecipientKeyPublicKey Property (ECC Class)

This property is a PEM formatted public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientKeyPublicKey();
int SetRecipientKeyPublicKey(const char* lpszRecipientKeyPublicKey);

Unicode (Windows)
LPWSTR GetRecipientKeyPublicKey();
INT SetRecipientKeyPublicKey(LPCWSTR lpszRecipientKeyPublicKey);

char* ipworksencrypt_ecc_getrecipientkeypublickey(void* lpObj);
int ipworksencrypt_ecc_setrecipientkeypublickey(void* lpObj, const char* lpszRecipientKeyPublicKey);

QString GetRecipientKeyPublicKey();
int SetRecipientKeyPublicKey(QString qsRecipientKeyPublicKey);

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

Represents the public key's Rx parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyRx(char* &lpRecipientKeyRx, int &lenRecipientKeyRx);
int SetRecipientKeyRx(const char* lpRecipientKeyRx, int lenRecipientKeyRx);

Unicode (Windows)
INT GetRecipientKeyRx(LPSTR &lpRecipientKeyRx, INT &lenRecipientKeyRx);
INT SetRecipientKeyRx(LPCSTR lpRecipientKeyRx, INT lenRecipientKeyRx);

int ipworksencrypt_ecc_getrecipientkeyrx(void* lpObj, char** lpRecipientKeyRx, int* lenRecipientKeyRx);
int ipworksencrypt_ecc_setrecipientkeyrx(void* lpObj, const char* lpRecipientKeyRx, int lenRecipientKeyRx);

QByteArray GetRecipientKeyRx();
int SetRecipientKeyRx(QByteArray qbaRecipientKeyRx);

Default Value

""

Remarks

Represents the public key's Rx parameter.

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

Data Type

Binary String

RecipientKeyRy Property (ECC Class)

Represents the public key's Ry parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyRy(char* &lpRecipientKeyRy, int &lenRecipientKeyRy);
int SetRecipientKeyRy(const char* lpRecipientKeyRy, int lenRecipientKeyRy);

Unicode (Windows)
INT GetRecipientKeyRy(LPSTR &lpRecipientKeyRy, INT &lenRecipientKeyRy);
INT SetRecipientKeyRy(LPCSTR lpRecipientKeyRy, INT lenRecipientKeyRy);

int ipworksencrypt_ecc_getrecipientkeyry(void* lpObj, char** lpRecipientKeyRy, int* lenRecipientKeyRy);
int ipworksencrypt_ecc_setrecipientkeyry(void* lpObj, const char* lpRecipientKeyRy, int lenRecipientKeyRy);

QByteArray GetRecipientKeyRy();
int SetRecipientKeyRy(QByteArray qbaRecipientKeyRy);

Default Value

""

Remarks

Represents the public key's Ry parameter.

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

Data Type

Binary String

RecipientKeyXPk Property (ECC Class)

Holds the public key data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientKeyXPk(char* &lpRecipientKeyXPk, int &lenRecipientKeyXPk);
int SetRecipientKeyXPk(const char* lpRecipientKeyXPk, int lenRecipientKeyXPk);

Unicode (Windows)
INT GetRecipientKeyXPk(LPSTR &lpRecipientKeyXPk, INT &lenRecipientKeyXPk);
INT SetRecipientKeyXPk(LPCSTR lpRecipientKeyXPk, INT lenRecipientKeyXPk);

int ipworksencrypt_ecc_getrecipientkeyxpk(void* lpObj, char** lpRecipientKeyXPk, int* lenRecipientKeyXPk);
int ipworksencrypt_ecc_setrecipientkeyxpk(void* lpObj, const char* lpRecipientKeyXPk, int lenRecipientKeyXPk);

QByteArray GetRecipientKeyXPk();
int SetRecipientKeyXPk(QByteArray qbaRecipientKeyXPk);

Default Value

""

Remarks

Holds the public key data.

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

Data Type

Binary String

SharedSecret Property (ECC Class)

The computed shared secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSharedSecret(char* &lpSharedSecret, int &lenSharedSecret);

Unicode (Windows)
INT GetSharedSecret(LPSTR &lpSharedSecret, INT &lenSharedSecret);

int ipworksencrypt_ecc_getsharedsecret(void* lpObj, char** lpSharedSecret, int* lenSharedSecret);

QByteArray GetSharedSecret();

Default Value

""

Remarks

This property holds the shared secret computed by ComputeSecret.

This property is read-only.

Data Type

Binary String

SignerKeyAlgorithm Property (ECC Class)

This property holds the algorithm associated with the key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyAlgorithm();
int SetSignerKeyAlgorithm(int iSignerKeyAlgorithm);

Unicode (Windows)
INT GetSignerKeyAlgorithm();
INT SetSignerKeyAlgorithm(INT iSignerKeyAlgorithm);

EA_SECP_256R_1(0), 
EA_SECP_384R_1(1), 
EA_SECP_521R_1(2), 
EA_ED_25519(3), 
EA_ED_448(4), 
EA_X25519(5), 
EA_X448(6), 
EA_SECP_160K_1(7), 
EA_SECP_192K_1(8), 
EA_SECP_224K_1(9), 
EA_SECP_256K_1(10), 
EA_BRAINPOOL_P160R_1(11), 
EA_BRAINPOOL_P192R_1(12), 
EA_BRAINPOOL_P224R_1(13), 
EA_BRAINPOOL_P256R_1(14), 
EA_BRAINPOOL_P320R_1(15), 
EA_BRAINPOOL_P384R_1(16), 
EA_BRAINPOOL_P512R_1(17), 
EA_BRAINPOOL_P160T_1(18), 
EA_BRAINPOOL_P192T_1(19), 
EA_BRAINPOOL_P224T_1(20), 
EA_BRAINPOOL_P256T_1(21), 
EA_BRAINPOOL_P320T_1(22), 
EA_BRAINPOOL_P384T_1(23), 
EA_BRAINPOOL_P512T_1(24)

int ipworksencrypt_ecc_getsignerkeyalgorithm(void* lpObj);
int ipworksencrypt_ecc_setsignerkeyalgorithm(void* lpObj, int iSignerKeyAlgorithm);

int GetSignerKeyAlgorithm();
int SetSignerKeyAlgorithm(int iSignerKeyAlgorithm);

Default Value

0

Remarks

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

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

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

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

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

Data Type

Integer

SignerKeyPublicKey Property (ECC Class)

This property is a PEM formatted public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerKeyPublicKey();
int SetSignerKeyPublicKey(const char* lpszSignerKeyPublicKey);

Unicode (Windows)
LPWSTR GetSignerKeyPublicKey();
INT SetSignerKeyPublicKey(LPCWSTR lpszSignerKeyPublicKey);

char* ipworksencrypt_ecc_getsignerkeypublickey(void* lpObj);
int ipworksencrypt_ecc_setsignerkeypublickey(void* lpObj, const char* lpszSignerKeyPublicKey);

QString GetSignerKeyPublicKey();
int SetSignerKeyPublicKey(QString qsSignerKeyPublicKey);

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

Represents the public key's Rx parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyRx(char* &lpSignerKeyRx, int &lenSignerKeyRx);
int SetSignerKeyRx(const char* lpSignerKeyRx, int lenSignerKeyRx);

Unicode (Windows)
INT GetSignerKeyRx(LPSTR &lpSignerKeyRx, INT &lenSignerKeyRx);
INT SetSignerKeyRx(LPCSTR lpSignerKeyRx, INT lenSignerKeyRx);

int ipworksencrypt_ecc_getsignerkeyrx(void* lpObj, char** lpSignerKeyRx, int* lenSignerKeyRx);
int ipworksencrypt_ecc_setsignerkeyrx(void* lpObj, const char* lpSignerKeyRx, int lenSignerKeyRx);

QByteArray GetSignerKeyRx();
int SetSignerKeyRx(QByteArray qbaSignerKeyRx);

Default Value

""

Remarks

Represents the public key's Rx parameter.

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

Data Type

Binary String

SignerKeyRy Property (ECC Class)

Represents the public key's Ry parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyRy(char* &lpSignerKeyRy, int &lenSignerKeyRy);
int SetSignerKeyRy(const char* lpSignerKeyRy, int lenSignerKeyRy);

Unicode (Windows)
INT GetSignerKeyRy(LPSTR &lpSignerKeyRy, INT &lenSignerKeyRy);
INT SetSignerKeyRy(LPCSTR lpSignerKeyRy, INT lenSignerKeyRy);

int ipworksencrypt_ecc_getsignerkeyry(void* lpObj, char** lpSignerKeyRy, int* lenSignerKeyRy);
int ipworksencrypt_ecc_setsignerkeyry(void* lpObj, const char* lpSignerKeyRy, int lenSignerKeyRy);

QByteArray GetSignerKeyRy();
int SetSignerKeyRy(QByteArray qbaSignerKeyRy);

Default Value

""

Remarks

Represents the public key's Ry parameter.

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

Data Type

Binary String

SignerKeyXPk Property (ECC Class)

Holds the public key data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerKeyXPk(char* &lpSignerKeyXPk, int &lenSignerKeyXPk);
int SetSignerKeyXPk(const char* lpSignerKeyXPk, int lenSignerKeyXPk);

Unicode (Windows)
INT GetSignerKeyXPk(LPSTR &lpSignerKeyXPk, INT &lenSignerKeyXPk);
INT SetSignerKeyXPk(LPCSTR lpSignerKeyXPk, INT lenSignerKeyXPk);

int ipworksencrypt_ecc_getsignerkeyxpk(void* lpObj, char** lpSignerKeyXPk, int* lenSignerKeyXPk);
int ipworksencrypt_ecc_setsignerkeyxpk(void* lpObj, const char* lpSignerKeyXPk, int lenSignerKeyXPk);

QByteArray GetSignerKeyXPk();
int SetSignerKeyXPk(QByteArray qbaSignerKeyXPk);

Default Value

""

Remarks

Holds the public key data.

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

Data Type

Binary String

UseHex Property (ECC Class)

Whether binary values are hex encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseHex();
int SetUseHex(int bUseHex);

Unicode (Windows)
BOOL GetUseHex();
INT SetUseHex(BOOL bUseHex);

int ipworksencrypt_ecc_getusehex(void* lpObj);
int ipworksencrypt_ecc_setusehex(void* lpObj, int bUseHex);

bool GetUseHex();
int SetUseHex(bool bUseHex);

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

Data Type

Boolean

ComputeSecret Method (ECC Class)

Computes a shared secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ComputeSecret();

Unicode (Windows)
INT ComputeSecret();

int ipworksencrypt_ecc_computesecret(void* lpObj);

int ComputeSecret();

Remarks

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

When this method is called the class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (ECC Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksencrypt_ecc_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateKey Method (ECC Class)

Creates a new key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateKey(const char* lpszKeyAlgorithm);

Unicode (Windows)
INT CreateKey(LPCWSTR lpszKeyAlgorithm);

int ipworksencrypt_ecc_createkey(void* lpObj, const char* lpszKeyAlgorithm);

int CreateKey(const QString& qsKeyAlgorithm);

Remarks

CreateKey creates a new public and private key.

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

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

NIST, Koblitz, and Brainpool Curve Notes

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

The public key consists of the following parameters:

• KeyRx
• KeyRy

The private key consists of one value:

• KeyK

Curve25519 and Curve448 Notes

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

KeyXPk holds the public key.

KeyXSk holds the private key.

Create Key Example (secp256r1 - PEM)

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

Create Key Example (secp256r1 - Raw Key Params)

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

Create Key Example (Ed25519 - PEM)

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

Create Key Example (Ed25519 - Raw Key Params)

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Decrypt Method (ECC Class)

Decrypted the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworksencrypt_ecc_decrypt(void* lpObj);

int 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 class 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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Encrypt Method (ECC Class)

Encrypts the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int ipworksencrypt_ecc_encrypt(void* lpObj);

int Encrypt();

Remarks

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

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

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

See CreateKey for details about key creation and algorithms.

When this method is called the class 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 class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (ECC Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_ecc_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (ECC Class)

Sets the stream from which the class will read data to encrypt or decrypt.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksEncryptStream* sInputStream);

int ipworksencrypt_ecc_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

This method sets the stream from which the class will read data to encrypt or decrypt.

Input and Output Properties

The class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetOutputStream Method (ECC Class)

Sets the stream to which the class will write encrypted or decrypted data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(IPWorksEncryptStream* sOutputStream);

int ipworksencrypt_ecc_setoutputstream(void* lpObj, IPWorksEncryptStream* sOutputStream);

int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Remarks

This method sets the stream to which the class will write encrypted or decrypted data.

Input and Output Properties

The class 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:

• SetInputStream
• InputFile
• InputMessage

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (ECC Class)

Creates a hash signature using ECDSA or EdDSA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int ipworksencrypt_ecc_sign(void* lpObj);

int Sign();

Remarks

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

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

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

See CreateKey for details about key creation and algorithms.

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

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

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

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

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

The following properties are applicable when calling this method:

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

The following properties are populated after calling this method:

• HashValue
• HashSignature

EdDSA Notes

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

• HashEdDSA
• EdDSAContext

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

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

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

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifySignature Method (ECC Class)

Verifies the signature for the specified data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();

int ipworksencrypt_ecc_verifysignature(void* lpObj);

bool 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 class will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.

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

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

The following properties are applicable when calling this method:

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Error Event (ECC Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(ECCErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} ECCErrorEventParams;


Unicode (Windows)
virtual INT FireError(ECCErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} ECCErrorEventParams;

#define EID_ECC_ERROR 1

virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class ECCErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(ECCErrorEventParams *e);

// Or, subclass ECC and override this emitter function.
virtual int FireError(ECCErrorEventParams *e) {...}

Remarks

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

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

Progress Event (ECC Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(ECCProgressEventParams *e);

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} ECCProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(ECCProgressEventParams *e);

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} ECCProgressEventParams;

#define EID_ECC_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class ECCProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(ECCProgressEventParams *e);

// Or, subclass ECC and override this emitter function.
virtual int FireProgress(ECCProgressEventParams *e) {...}

Remarks

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

The PercentProcessed parameter indicates the current status of the operation.

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

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The ECC class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the ECC class an instance of that concrete class.

When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (ECC Class)

ECC Config Settings

Base Config Settings

Trappable Errors (ECC Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ECC Errors