ECC Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksencrypt.ecc()

Remarks

The ECC (Elliptic Curve Cryptography) class implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The 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 it. 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 properties hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.

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

KeyAlgorithmSupported Operations
secp256r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp384r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp521r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
X25519ECDH (ComputeSecret)
X448ECDH (ComputeSecret)
Ed25519EdDSA (Sign and VerifySignature)
Ed448EdDSA (Sign and VerifySignature)
secp160k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp192k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp224k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp256k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP160r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP192r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP224r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP256r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP320r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP384r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP512r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP160t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP192t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP224t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP256t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP320t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP384t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP512t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)

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:

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 hash the input data and sign the resulting hash.

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

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

See CreateKey for details about key creation and algorithms.

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

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

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

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

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

The following properties are applicable when calling this method:

The following properties are populated after calling this method:

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

EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the HashEdDSA property. By default, the 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 that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, HashValue is not applicable.

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

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

Verifying (ECDSA and EdDSA)

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

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

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

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

Encrypting (ECIES)

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

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

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

See CreateKey for details about key creation and algorithms.

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

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:

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

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:

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:

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

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.

CertificateThe certificate used for signing and decryption.
ComputeSecretKDFThe key derivation function.
EncryptionAlgorithmThe encryption algorithm to use.
HashAlgorithmThe hash algorithm used for hash computation.
HashEdDSAWhether to use HashEdDSA when signing with an Ed25519 or Ed448 key.
HashSignatureThe hash signature.
HashValueThe hash value of the data.
HMACAlgorithmThe HMAC algorithm to use during encryption.
InputFileThe file to process.
InputMessageThe message to process.
IVThe initialization vector (IV) used when encrypting.
KDFThe key derivation function used during encryption and decryption.
KDFHashAlgorithmThe KDF hash algorithm to use when encrypting and decrypting.
KeyThe ECC key.
OutputFileThe output file when encrypting or decrypting.
OutputMessageThe output message when encrypting or decrypting.
OverwriteIndicates whether or not the class should overwrite files.
RecipientCertThe certificate used for encryption and computing a shared secret.
RecipientKeyThe public key used to compute the shared secret.
SharedSecretThe computed shared secret.
SignerCertThe certificate used for signature verification.
SignerKeyThe public key used to verify the signature.
UseHexWhether binary values are hex encoded.

Method List


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

ComputeSecretComputes a shared secret.
ConfigSets or retrieves a configuration setting.
CreateKeyCreates a new key.
DecryptDecrypted the specified data.
EncryptEncrypts the specified data.
ResetResets the class.
SignCreates a hash signature using ECDSA or EdDSA.
VerifySignatureVerifies the signature for the specified data.

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.

ErrorFired when information is available about errors during data delivery.
ProgressFired as progress is made.

Config Settings


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

AppendSecretAn optional string to append to the secret agreement.
CNGECDHKeyThe CNG ECDH key.
CNGECDSAKeyThe CNG ECDSA key.
ConcatAlgorithmIdThe AlgorithmId subfield of the OtherInfo field.
ConcatHashAlgorithmThe hash algorithm to use when ComputeSecretKDF is Concat.
ConcatPartyUInfoThe PartyUInfo subfield of the OtherInfo field.
ConcatPartyVInfoThe PartyVInfo subfield of the OtherInfo field.
ConcatSuppPrivInfoThe SuppPrivInfo subfield of the OtherInfo field.
ConcatSuppPubInfoThe SuppPubInfo subfield of the OtherInfo field.
ECDSASignatureFormatThe format of the HashSignature when using ECDSA keys.
EdDSAContextA hex encoded string holding the bytes of the context when signing or verifying with Ed25519ctx.
EncryptionKeySizeThe encryption key size.
HMACKeyA key to use when generating a Hash-based Message Authentication Code (HMAC).
HMACKeySizeThe HMAC key size to be used during encryption.
HMACOptionalInfoOptional data to be used during encryption and decryption during the HMAC step.
KDFOptionalInfoOptional data to be used during encryption and decryption during the key derivation step.
PrependSecretAn optional string to prepend to the secret agreement.
StrictKeyValidationWhether to validate provided public keys based on private keys.
TLSLabelThe TLS PRF label.
TLSSeedThe TLS PRF Seed.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

ECC.Certificate Property

The certificate used for signing and decryption.

Syntax

getCertificate(): Certificate;
setCertificate(certificate: Certificate): void;

Default Value

Remarks

This property specifies a certificate with a private key.

This may be set instead of Key, allowing a Certificate object to be used instead of a ECCKey object. This certificate is used when calling Sign and Decrypt. The specified certificate must have a private key.

If both this property and Key are specified, Key will be used and this property will be ignored.

Please refer to the Certificate type for a complete list of fields.

ECC.ComputeSecretKDF Property

The key derivation function.

Syntax

getComputeSecretKDF(): ECCComputeSecretKDFs;
setComputeSecretKDF(computeSecretKDF: ECCComputeSecretKDFs): void;

enum ECCComputeSecretKDFs { ekdSHA1, ekdSHA256, ekdSHA384, ekdSHA512, ekdMD2, ekdMD4, ekdMD5, ekdHMACSHA1, ekdHMACSHA256, ekdHMACSHA384, ekdHMACSHA512, ekdHMACMD5, ekdTLS, ekdConcat }

Default Value

1

Remarks

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

Possible values are:

0 (ekdSHA1) SHA-1
1 (ekdSHA256 - default) SHA-256
2 (ekdSHA384) SHA-384
3 (ekdSHA512) SHA-512
4 (ekdMD2) MD2
5 (ekdMD4) MD4
6 (ekdMD5) MD5
7 (ekdHMACSHA1) HMAC-SHA1
8 (ekdHMACSHA256) HMAC-SHA256
9 (ekdHMACSHA384) HMAC-SHA384
10 (ekdHMACSHA512) HMAC-SHA512
11 (ekdHMACMD5) HMAC-MD5
12 (ekdTLS) TLS
13 (ekdConcat) Concat

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:

ECC.EncryptionAlgorithm Property

The encryption algorithm to use.

Syntax

getEncryptionAlgorithm(): ECCEncryptionAlgorithms;
setEncryptionAlgorithm(encryptionAlgorithm: ECCEncryptionAlgorithms): void;

enum ECCEncryptionAlgorithms { iesAES, iesTripleDES, iesXOR }

Default Value

0

Remarks

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

Possible values are:

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

AES Notes

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

ECC.HashAlgorithm Property

The hash algorithm used for hash computation.

Syntax

getHashAlgorithm(): ECCHashAlgorithms;
setHashAlgorithm(hashAlgorithm: ECCHashAlgorithms): void;

enum ECCHashAlgorithms { ehaSHA1, ehaSHA224, ehaSHA256, ehaSHA384, ehaSHA512, ehaMD2, ehaMD4, ehaMD5, ehaMD5SHA1, ehaRIPEMD160 }

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:

0 (ehaSHA1) SHA-1
1 (ehaSHA224) SHA-224
2 (ehaSHA256 - default) SHA-256
3 (ehaSHA384) SHA-384
4 (ehaSHA512) SHA-512
5 (ehaMD2) MD2
6 (ehaMD4) MD4
7 (ehaMD5) MD5
8 (ehaMD5SHA1) MD5SHA-1
9 (ehaRIPEMD160) RIPEMD-160

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

ECC.HashEdDSA Property

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

Syntax

isHashEdDSA(): boolean;
setHashEdDSA(hashEdDSA: boolean): void;

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 that even if it is feasible to compute collisions for the hash function, the algorithm is still secure.

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

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

ECC.HashSignature Property

The hash signature.

Syntax

getHashSignature(): Uint8Array;
setHashSignature(hashSignature: Uint8Array): void;

Default Value

""

Remarks

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

ECC.HashValue Property

The hash value of the data.

Syntax

getHashValue(): Uint8Array;
setHashValue(hashValue: Uint8Array): void;

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

ECC.HMACAlgorithm Property

The HMAC algorithm to use during encryption.

Syntax

getHMACAlgorithm(): ECCHMACAlgorithms;
setHMACAlgorithm(HMACAlgorithm: ECCHMACAlgorithms): void;

enum ECCHMACAlgorithms { iesHMACSHA1, iesHMACSHA224, iesHMACSHA256, iesHMACSHA384, iesHMACSHA512, iesHMACRIPEMD160 }

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.

ECC.InputFile Property

The file to process.

Syntax

getInputFile(): string;
setInputFile(inputFile: string): void;

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:

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

ECC.InputMessage Property

The message to process.

Syntax

getInputMessage(): Uint8Array;
setInputMessage(inputMessage: Uint8Array): void;

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:

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

ECC.IV Property

The initialization vector (IV) used when encrypting.

Syntax

getIV(): Uint8Array;
setIV(IV: Uint8Array): void;

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:

EncryptionAlgorithmIV Length (in bytes)
AES16
3DES8

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

ECC.KDF Property

The key derivation function used during encryption and decryption.

Syntax

getKDF(): string;
setKDF(KDF: string): void;

Default Value

"KDF2"

Remarks

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

  • "KDF1"
  • "KDF2" (default)
The KDFHashAlgorithm specifies the hash algorithm used in conjunction with the specified KDF.

This property is only applicable when calling Encrypt or Decrypt.

ECC.KDFHashAlgorithm Property

The KDF hash algorithm to use when encrypting and decrypting.

Syntax

getKDFHashAlgorithm(): ECCKDFHashAlgorithms;
setKDFHashAlgorithm(KDFHashAlgorithm: ECCKDFHashAlgorithms): void;

enum ECCKDFHashAlgorithms { iesSHA1, iesSHA224, iesSHA256, iesSHA384, iesSHA512 }

Default Value

2

Remarks

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

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

This property is only applicable when calling Encrypt or Decrypt.

ECC.Key Property

The ECC key.

Syntax

getKey(): ECCKey;
setKey(key: ECCKey): void;

Default Value

Remarks

This property specifies the ECC private key. This property must be set before calling Sign or ComputeSecret.

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.

Please refer to the ECCKey type for a complete list of fields.

ECC.OutputFile Property

The output file when encrypting or decrypting.

Syntax

getOutputFile(): string;
setOutputFile(outputFile: string): void;

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:

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

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

ECC.OutputMessage Property

The output message when encrypting or decrypting.

Syntax

getOutputMessage(): Uint8Array;

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:

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

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

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

ECC.Overwrite Property

Indicates whether or not the class should overwrite files.

Syntax

isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;

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.

ECC.RecipientCert Property

The certificate used for encryption and computing a shared secret.

Syntax

getRecipientCert(): Certificate;
setRecipientCert(recipientCert: Certificate): void;

Default Value

Remarks

This property specifies a certificate for encryption and computing a shared secret.

This may be set instead of RecipientKey, allowing a Certificate object to be used instead of a ECCKey object. This certificate is used when calling Encrypt and ComputeSecret.

If both this property and RecipientKey are specified, RecipientKey will be used and this property will be ignored.

Please refer to the Certificate type for a complete list of fields.

ECC.RecipientKey Property

The public key used to compute the shared secret.

Syntax

getRecipientKey(): ECCKey;
setRecipientKey(recipientKey: ECCKey): void;

Default Value

Remarks

This property specifies the public key used to compute the shared secret. If RecipientCert is not specified, this must be set before calling ComputeSecret.

Please refer to the ECCKey type for a complete list of fields.

ECC.SharedSecret Property

The computed shared secret.

Syntax

getSharedSecret(): Uint8Array;

Default Value

""

Remarks

This property holds the shared secret computed by ComputeSecret.

This property is read-only.

ECC.SignerCert Property

The certificate used for signature verification.

Syntax

getSignerCert(): Certificate;
setSignerCert(signerCert: Certificate): void;

Default Value

Remarks

This property specifies a certificate for signature verification.

This may be set instead of SignerKey, allowing a Certificate object to be used instead of a ECCKey object. This certificate is used when calling VerifySignature.

If both this property and SignerKey are specified, SignerKey will be used and this property will be ignored.

Please refer to the Certificate type for a complete list of fields.

ECC.SignerKey Property

The public key used to verify the signature.

Syntax

getSignerKey(): ECCKey;
setSignerKey(signerKey: ECCKey): void;

Default Value

Remarks

This property specifies the public key used to verify the signature. This public key corresponds to the private key used when creating the signature. This must be set before calling VerifySignature.

Please refer to the ECCKey type for a complete list of fields.

ECC.UseHex Property

Whether binary values are hex encoded.

Syntax

isUseHex(): boolean;
setUseHex(useHex: boolean): void;

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.

ECC.computeSecret Method

Computes a shared secret.

Syntax

async ecc.computeSecret(): Promise<void>

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:

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.

ECC.config Method

Sets or retrieves a configuration setting.

Syntax

async ecc.config(configurationString : string): Promise<string>

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.

ECC.createKey Method

Creates a new key.

Syntax

async ecc.createKey(keyAlgorithm : string): Promise<void>

Remarks

CreateKey creates a new public and private key.

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

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

KeyAlgorithmSupported Operations
secp256r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp384r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp521r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
X25519ECDH (ComputeSecret)
X448ECDH (ComputeSecret)
Ed25519EdDSA (Sign and VerifySignature)
Ed448EdDSA (Sign and VerifySignature)
secp160k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp192k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp224k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp256k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP160r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP192r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP224r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP256r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP320r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP384r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP512r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP160t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP192t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP224t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP256t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP320t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP384t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP512t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)

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"

ECC.decrypt Method

Decrypted the specified data.

Syntax

async ecc.decrypt(): Promise<void>

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:

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:

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

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

ECC.encrypt Method

Encrypts the specified data.

Syntax

async ecc.encrypt(): Promise<void>

Remarks

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

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

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

See CreateKey for details about key creation and algorithms.

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

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:

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

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

ECC.reset Method

Resets the class.

Syntax

async ecc.reset(): Promise<void>

Remarks

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

ECC.sign Method

Creates a hash signature using ECDSA or EdDSA.

Syntax

async ecc.sign(): Promise<void>

Remarks

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

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

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

See CreateKey for details about key creation and algorithms.

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

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

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

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

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

The following properties are applicable when calling this method:

The following properties are populated after calling this method:

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

EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the HashEdDSA property. By default, the 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 that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, HashValue is not applicable.

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

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

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

ECC.verifySignature Method

Verifies the signature for the specified data.

Syntax

async ecc.verifySignature(): Promise<boolean>

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:

Sign And Verify Example (ECDSA)

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

Sign And Verify Example (EdDSA - PureEdDSA)

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

Sign And Verify Example (EdDSA - HashEdDSA)

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

ECC.Error Event

Fired when information is available about errors during data delivery.

Syntax

ecc.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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

ECC.Progress Event

Fired as progress is made.

Syntax

ecc.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
string (read-only)

Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
string (read-only)

Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string (read-only)

Default Value: ""

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

Fingerprint
string (read-only)

Default Value: ""

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

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

FingerprintSHA1
string (read-only)

Default Value: ""

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

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

FingerprintSHA256
string (read-only)

Default Value: ""

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

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

Issuer
string (read-only)

Default Value: ""

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

KeyPassword
string

Default Value: ""

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys.

Note: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

PrivateKey
string (read-only)

Default Value: ""

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

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

PrivateKeyAvailable
boolean (read-only)

Default Value: False

Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)

Default Value: ""

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

PublicKey
string (read-only)

Default Value: ""

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

PublicKeyAlgorithm
string (read-only)

Default Value: ""

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

PublicKeyLength
number (read-only)

Default Value: 0

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

SerialNumber
string (read-only)

Default Value: ""

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

SignatureAlgorithm
string (read-only)

Default Value: ""

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

Store
string

Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
Uint8Array

Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
string

Default Value: ""

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

StoreType
CertStoreTypes

Default Value: 0

The type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the and set to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
string (read-only)

Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)

Default Value: ""

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

ThumbprintSHA1
string (read-only)

Default Value: ""

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

ThumbprintSHA256
string (read-only)

Default Value: ""

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

Usage
string (read-only)

Default Value: ""

The text description of .

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

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

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

UsageFlags
number (read-only)

Default Value: 0

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

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the property for a text representation of .

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

Version
string (read-only)

Default Value: ""

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

Subject
string

Default Value: ""

The subject of the certificate used for client authentication.

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Encoded
string

Default Value: ""

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

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

EncodedB
Uint8Array

Default Value: ""

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

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

Constructors

public Certificate();

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] encoded);

Parses Encoded as an X.509 public key.

public Certificate(int storeType, String store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int storeType, byte[] store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

ECCKey Type

Contains the parameters for the ECC algorithm.

Remarks

This type is made up of fields that represent the private and public key parameters used by the ECC operations. The and parameters hold a PEM formatted value for easy transport and storage of keys.

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.

The following fields are available:

Fields

Algorithm
ECAlgorithms

Default Value: 0

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 and , the property will be automatically updated with the key algorithm.

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

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

KeyAlgorithmSupported Operations
secp256r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp384r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp521r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
X25519ECDH (ComputeSecret)
X448ECDH (ComputeSecret)
Ed25519EdDSA (Sign and VerifySignature)
Ed448EdDSA (Sign and VerifySignature)
secp160k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp192k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp224k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
secp256k1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP160r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP192r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP224r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP256r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP320r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP384r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP512r1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP160t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP192t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP224t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP256t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP320t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP384t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)
brainpoolP512t1ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature)

K
string

Default Value: ""

Represents the private key (K) parameter.

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

KB
Uint8Array

Default Value: ""

Represents the private key (K) parameter.

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

PrivateKey
string

Default Value: ""

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.

PublicKey
string

Default Value: ""

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.

Rx
string

Default Value: ""

Represents the public key's Rx parameter.

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

RxB
Uint8Array

Default Value: ""

Represents the public key's Rx parameter.

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

Ry
string

Default Value: ""

Represents the public key's Ry parameter.

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

RyB
Uint8Array

Default Value: ""

Represents the public key's Ry parameter.

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

XPk
string

Default Value: ""

Holds the public key data.

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

XPkB
Uint8Array

Default Value: ""

Holds the public key data.

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

XSk
string

Default Value: ""

Holds the private key data.

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

XSkB
Uint8Array

Default Value: ""

Holds the private key data.

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

Constructors

public ECCKey();

The default constructor creates a new ECCKey instance but does not assign a public or private key.

public ECCKey(byte[] rx, byte[] ry, int algorithm);

The public key constructor assigns an existing public key.

public ECCKey(byte[] K, byte[] rx, byte[] ry, int algorithm);

The private key constructor assigns an existing private key.

Config Settings (class ipworksencrypt.ecc)

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

ECC Config Settings

AppendSecret:   An optional string to append to the secret agreement.

This setting specifies an optional string to append to the secret agreement before hashing it. This is applicable when calling ComputeSecret.

Note: This is not applicable when ComputeSecretKDF is set to 12 (ekdTLS).

CNGECDHKey:   The CNG ECDH key.

This setting may be set to specify the key exported from Microsoft's CNG before calling ComputeSecret. If key data was obtained from Microsoft's CNG API, it can be hex encoded and supplied here. The class will use this key when ComputeSecret is called.

CNGECDSAKey:   The CNG ECDSA key.

This setting may be set to specify the key exported from Microsoft's CNG before calling VerifySignature. If key data was obtained from Microsoft's CNG API, it can be hex encoded and supplied here. The class will use this key when VerifySignature is called.

ConcatAlgorithmId:   The AlgorithmId subfield of the OtherInfo field.

This setting specifies the AlgorithmId subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data.

This setting is required when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.

ConcatHashAlgorithm:   The hash algorithm to use when ComputeSecretKDF is Concat.

This setting optionally specifies the hash algorithm to use when ComputeSecretKDF is set to ekdConcat. Possible values are:

  • SHA1
  • SHA224
  • SHA256 (default)
  • SHA384
  • SHA512
  • RIPEMD160
ConcatPartyUInfo:   The PartyUInfo subfield of the OtherInfo field.

This setting specifies the PartyUInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data.

This setting is required when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.

ConcatPartyVInfo:   The PartyVInfo subfield of the OtherInfo field.

This setting specifies the PartyVInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data.

This setting is required when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.

ConcatSuppPrivInfo:   The SuppPrivInfo subfield of the OtherInfo field.

This setting specifies the SuppPrivInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data.

This setting is optional when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.

ConcatSuppPubInfo:   The SuppPubInfo subfield of the OtherInfo field.

This setting specifies the SuppPubInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data.

This setting is optional when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.

ECDSASignatureFormat:   The format of the HashSignature when using ECDSA keys.

This setting specifies the format of HashSignature when signing with ECDSA keys. The way the HashSignature parameters are represented can be changed to be interoperable with other implementations. Possible values are:

  • 0 (Concatenated - default)
  • 1 (ASN)

Note: This setting is only applicable when KeyAlgorithm is set to a NIST, Koblitz, or Brainpool curve.

EdDSAContext:   A hex encoded string holding the bytes of the context when signing or verifying with Ed25519ctx.

This setting specifies up to 255 bytes of context data as a hex encoded string for signing and verifying.

This setting is only applicable when KeyAlgorithm is set to Ed25519 or Ed448. When this setting is specified, the KeyAlgorithm is Ed25519, and HashEdDSA is False, the class will automatically use Ed25519ctx.

If this value is specified before calling Sign, it must also be set prior to calling VerifySignature.

EncryptionKeySize:   The encryption key size.

This setting specifies the AES encryption key size in bits when EncryptionAlgorithm is set to AES. Possible values are:

  • 128
  • 192
  • 256 (default)
This setting is only applicable when calling Encrypt.
HMACKey:   A key to use when generating a Hash-based Message Authentication Code (HMAC).

This key is incorporated into the hashing process to add entropy to the resulting hash code, making the plaintext harder to guess and increasing the message security. The value supplied here must be hex encoded.

This is only applicable when calling ComputeSecret.

HMACKeySize:   The HMAC key size to be used during encryption.

This setting optionally specifies the HMAC key size to be used during encryption and decryption. If set to 0 (default), the class will automatically select the key size based on the algorithm specified in HMACAlgorithm.

This setting is only applicable when calling Encrypt or Decrypt.

HMACOptionalInfo:   Optional data to be used during encryption and decryption during the HMAC step.

This setting optionally specifies data to be used with the specified HMACAlgorithm as part of the encryption and decryption process. This is additional data known to both parties that is included while performing the HMAC operation.

The value specified in this setting must a hex string.

If specified, this must be set before calling both Encrypt and Decrypt.

KDFOptionalInfo:   Optional data to be used during encryption and decryption during the key derivation step.

This setting optionally specifies data to be used with the specified KDF as part of the encryption and decryption process. This is additional data known to both parties that is included while performing key derivation.

The value specified in this setting must a hex string.

If specified, this must be set before calling both Encrypt and Decrypt.

PrependSecret:   An optional string to prepend to the secret agreement.

This setting specifies an optional string to prepend to the secret agreement before hashing it. This is applicable when calling ComputeSecret.

Note: This is not applicable when ComputeSecretKDF is set to 12 (ekdTLS).

StrictKeyValidation:   Whether to validate provided public keys based on private keys.

This setting performs additional checks prior to using specified keys to validate that the public key corresponds to the provided private key.

When using keys with the algorithm Ed25519, Ed448, X25519, or X448, the class will calculate the public key based on the provided private key and compare it to the provided public key to ensure they match.

When using keys with a NIST, Koblitz, or Brainpool curve, the class will perform calculations to verify that the public key is a point on the curve. The class will also calculate the public key based on the provided private key and compare it to the provided public key to ensure they match.

The default value is False and the class will use the public and private keys as provided without any additional checks.

TLSLabel:   The TLS PRF label.

This setting specifies a string representing the PRF label. This setting is required when ComputeSecretKDF set to 12 (ekdTLS). It is only applicable when calling ComputeSecret.

TLSSeed:   The TLS PRF Seed.

This setting specifies the hex encoded TLS PRF Seed. The seed value must be 64 bytes in length before hex encoding. This setting is required when ComputeSecretKDF set to 12 (ekdTLS). It is only applicable when calling ComputeSecret.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

Trappable Errors (class ipworksencrypt.ecc)

ECC Errors

102   No Key specified.
104   Cannot read or write file.
111   OutputFile already exists and Overwrite is False.
120   Invalid curve.
124   HashSignature must be specified.
304   Cannot write file.
305   Cannot read file.
306   Cannot create file.
1401   Specified ECC parameters are invalid.
1402   Missing hash value.
1403   Public key must be specified.
1404   Key must be specified.
1405   HashSignature must be specified.
1406   Invalid key size.
1407   Invalid TLS seed. TLSSeed must be 64 bytes long.
1408   Invalid TLS label.
1409   Unsupported key format.
1410   Unsupported curve.