ECC Control
Properties Methods Events Config Settings Errors
The ECC (Elliptic Curve Cryptography) control implements ECDSA, EdDSA, ECDH, and ECIES operations.
Syntax
ECC
Remarks
The ECC (Elliptic Curve Cryptography) control implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The control supports the following common operations:
- CreateKey allows key creation using algorithms such as secp256r1, secp384r1, secp521r1, X25519, X448, Ed25519, Ed448, and more.
- ComputeSecret computes a shared secret between two parties using a public and private key (ECDH).
- Sign and VerifySignature provides a way to digitally sign data and verify signatures (ECDSA and EdDSA).
- Encrypt and Decrypt encrypt and decrypt data using a public and private key (ECIES).
The control is very flexible and offers many properties and configuration settings to configure it. The sections below detail the use of the control for each of the major operations listed above.
Key Creation and Management
CreateKey creates a new public and private key.
When this method is called, Key is populated with the generated key. The KeyPublicKey and KeyPrivateKey properties hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.
The KeyAlgorithm parameter specifies the algorithm for which the key is intended to be used. Possible values are:
NIST, Koblitz, and Brainpool Curve Notes
Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters.
The public key consists of the following parameters:
The private key consists of one value:
Curve25519 and Curve448 Notes
Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.
KeyXPk holds the public key.
KeyXSk holds the private key.
Create Key Example (secp256r1 - PEM)
//Create a key using secp256r1
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (secp256r1 - Raw Key Params)
//Create a key using secp256r1 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
byte[] K = ecc.Key.KB; //Private key param
byte[] Rx = ecc.Key.RxB; //Public key param
byte[] Ry = ecc.Key.RyB; //Public key param
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaSecp256r1; //This MUST be set manually when using key params directly
ecc.Key.KB = K;
ecc.Key.RxB = Rx;
ecc.Key.RyB = Ry;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (Ed25519 - PEM)
//Create a key using Ed25519
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Create Key Example (Ed25519 - Raw Key Params)
//Create a key using Ed25519 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
byte[] XPk = ecc.Key.XPkB; //Public key data
byte[] XSk = ecc.Key.XSkB; //Secret key data
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaEd25519; //This MUST be set manually when using key params directly
ecc.Key.XPkB = XPk;
ecc.Key.XSkB = XSk;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Compute Secret (ECDH)
This method computes a shared secret using Elliptic Curve Diffie Hellman (ECDH).
When this method is called, the control will use the public key specified by RecipientKeyPublicKey and the private key specified by Key to compute a shared secret, or secret agreement. The ComputeSecretKDF property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by SharedSecret. The following properties are applicable when calling this method:
- Key (required)
- RecipientKeyPublicKey (required)
- ComputeSecretKDF (optional)
See ComputeSecretKDF for details on advanced settings that may be applicable for the chosen algorithm.
Keys created with the Ed25519 and Ed448 algorithms are not supported when calling this method.
Compute Secret Example
//Create a key for Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("X25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Create a key for Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("X25519");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Note: the public keys must be exchanged between parties by some mechanism
//Create the shared secret on Party 1
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv; //Private key of this party
ecc1.RecipientKey.PublicKey = ecc2_pub; //Public key of other party
ecc1.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc1.ComputeSecret();
Console.WriteLine(ecc1.SharedSecret);
//Create the shared secret on Party 2
ecc2.Reset();
ecc2.Key.PrivateKey = ecc2_priv; //Private key of this party
ecc2.RecipientKey.PublicKey = ecc1_pub; //Public key of other party
ecc2.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc2.ComputeSecret();
Console.WriteLine(ecc2.SharedSecret); //This will match the shared secret created by ecc1.
Signing (ECDSA and EdDSA)
Sign will create a hash signature using ECDSA or EdDSA. The control will use the key specified by Key to hash the input data and sign the resulting hash.
Key must contain a private key created with a valid ECDSA or EdDSA algorithm. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for signing are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
- Ed25519 and Ed448
See CreateKey for details about key creation and algorithms.
When this method is called, data will be read from the InputFile or InputMessage.
The hash to be signed will be computed using the specified HashAlgorithm. The computed hash is stored in the HashValue property. The signed hash is stored in the HashSignature property.
To sign a hash without first computing it, set HashValue to a previously computed hash for the input data. Note: HashValue is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448.
The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.
After calling Sign, the public key must be sent to the recipient along with HashSignature and the original input data so the other party may perform signature verification.
The following properties are applicable when calling this method:
- Key (required)
- HashAlgorithm (applicable to ECDSA only)
- HashEdDSA (applicable to EdDSA only)
- HashValue (not applicable to PureEdDSA)
- UseHex
The following properties are populated after calling this method:
EdDSA Notes
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 control uses the PureEdDSA algorithm.
The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means 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 control will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.
To verify the hash signature without first computing the hash, simply specify HashValue before calling this method. Note: HashValue is not applicable when the message was signed with a PureEdDSA algorithm such as Ed25519 or Ed448.
The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.
The following properties are applicable when calling this method:
- HashSignature (required)
- SignerKey (required)
- EdDSAContext (applicable to EdDSA only)
- HashAlgorithm (applicable to ECDSA only)
- HashEdDSA (applicable to EdDSA only)
- HashValue (not applicable to PureEdDSA)
- UseHex
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to 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 control will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output, set UseHex to True.
The following properties are applicable when calling this method:
- EncryptionAlgorithm
- HMACAlgorithm
- HMACOptionalInfo
- HMACKeySize
- IV
- KDF
- KDFHashAlgorithm
- KDFOptionalInfo
- UseHex
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Decrypting (ECIES)
Decrypt decrypts the specified data with the ECDSA private key specified in Key.
Decryption is performed using ECIES which requires an ECDSA key. Key must contain an ECDSA key. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See CreateKey for details about key creation and algorithms.
When this method is called, the control will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set UseHex to True.
The following properties are applicable when calling this method:
- EncryptionAlgorithm
- HMACAlgorithm
- HMACOptionalInfo
- HMACKeySize
- IV
- KDF
- KDFHashAlgorithm
- KDFOptionalInfo
- UseHex
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| CertEffectiveDate | This is the date on which this certificate becomes valid. |
| CertExpirationDate | This is the date the certificate expires. |
| CertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
| CertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| CertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| CertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| CertIssuer | This is the issuer of the certificate. |
| CertPrivateKey | This is the private key of the certificate (if available). |
| CertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
| CertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
| CertPublicKey | This is the public key of the certificate. |
| CertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
| CertPublicKeyLength | This is the length of the certificate's public key (in bits). |
| CertSerialNumber | This is the serial number of the certificate encoded as a string. |
| CertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
| CertStore | This is the name of the certificate store for the client certificate. |
| CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| CertStoreType | This is the type of certificate store for this certificate. |
| CertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
| CertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
| CertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
| CertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
| CertUsage | This property contains the text description of UsageFlags . |
| CertUsageFlags | This property contains the flags that show intended use for the certificate. |
| CertVersion | This property contains the certificate's version number. |
| CertSubject | This is the subject of the certificate used for client authentication. |
| CertEncoded | This is the certificate (PEM/base64 encoded). |
| ComputeSecretKDF | The key derivation function. |
| EncryptionAlgorithm | The encryption algorithm to use. |
| HashAlgorithm | The hash algorithm used for hash computation. |
| HashEdDSA | Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key. |
| HashSignature | The hash signature. |
| HashValue | The hash value of the data. |
| HMACAlgorithm | The HMAC algorithm to use during encryption. |
| InputFile | The file to process. |
| InputMessage | The message to process. |
| IV | The initialization vector (IV) used when encrypting. |
| KDF | The key derivation function used during encryption and decryption. |
| KDFHashAlgorithm | The KDF hash algorithm to use when encrypting and decrypting. |
| KeyAlgorithm | This property holds the algorithm associated with the key. |
| KeyK | Represents the private key (K) parameter. |
| KeyPrivateKey | This property is a PEM formatted private key. |
| KeyPublicKey | This property is a PEM formatted public key. |
| KeyRx | Represents the public key's Rx parameter. |
| KeyRy | Represents the public key's Ry parameter. |
| KeyXPk | Holds the public key data. |
| KeyXSk | Holds the private key data. |
| OutputFile | The output file when encrypting or decrypting. |
| OutputMessage | The output message when encrypting or decrypting. |
| Overwrite | Indicates whether or not the control should overwrite files. |
| RecipientCertEffectiveDate | This is the date on which this certificate becomes valid. |
| RecipientCertExpirationDate | This is the date the certificate expires. |
| RecipientCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
| RecipientCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| RecipientCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| RecipientCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| RecipientCertIssuer | This is the issuer of the certificate. |
| RecipientCertPrivateKey | This is the private key of the certificate (if available). |
| RecipientCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
| RecipientCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
| RecipientCertPublicKey | This is the public key of the certificate. |
| RecipientCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
| RecipientCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
| RecipientCertSerialNumber | This is the serial number of the certificate encoded as a string. |
| RecipientCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
| RecipientCertStore | This is the name of the certificate store for the client certificate. |
| RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| RecipientCertStoreType | This is the type of certificate store for this certificate. |
| RecipientCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
| RecipientCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
| RecipientCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
| RecipientCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
| RecipientCertUsage | This property contains the text description of UsageFlags . |
| RecipientCertUsageFlags | This property contains the flags that show intended use for the certificate. |
| RecipientCertVersion | This property contains the certificate's version number. |
| RecipientCertSubject | This is the subject of the certificate used for client authentication. |
| RecipientCertEncoded | This is the certificate (PEM/base64 encoded). |
| RecipientKeyAlgorithm | This property holds the algorithm associated with the key. |
| RecipientKeyPublicKey | This property is a PEM formatted public key. |
| RecipientKeyRx | Represents the public key's Rx parameter. |
| RecipientKeyRy | Represents the public key's Ry parameter. |
| RecipientKeyXPk | Holds the public key data. |
| SharedSecret | The computed shared secret. |
| SignerCertEffectiveDate | This is the date on which this certificate becomes valid. |
| SignerCertExpirationDate | This is the date the certificate expires. |
| SignerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
| SignerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SignerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SignerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SignerCertIssuer | This is the issuer of the certificate. |
| SignerCertPrivateKey | This is the private key of the certificate (if available). |
| SignerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
| SignerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
| SignerCertPublicKey | This is the public key of the certificate. |
| SignerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
| SignerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
| SignerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
| SignerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
| SignerCertStore | This is the name of the certificate store for the client certificate. |
| SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SignerCertStoreType | This is the type of certificate store for this certificate. |
| SignerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
| SignerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
| SignerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
| SignerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
| SignerCertUsage | This property contains the text description of UsageFlags . |
| SignerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
| SignerCertVersion | This property contains the certificate's version number. |
| SignerCertSubject | This is the subject of the certificate used for client authentication. |
| SignerCertEncoded | This is the certificate (PEM/base64 encoded). |
| SignerKeyAlgorithm | This property holds the algorithm associated with the key. |
| SignerKeyPublicKey | This property is a PEM formatted public key. |
| SignerKeyRx | Represents the public key's Rx parameter. |
| SignerKeyRy | Represents the public key's Ry parameter. |
| SignerKeyXPk | Holds the public key data. |
| UseHex | Whether binary values are hex encoded. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| ComputeSecret | Computes a shared secret. |
| Config | This method sets or retrieves a configuration setting. |
| CreateKey | Creates a new key. |
| Decrypt | Decrypted the specified data. |
| Encrypt | Encrypts the specified data. |
| Reset | Resets the control. |
| Sign | Creates a hash signature using ECDSA or EdDSA. |
| VerifySignature | Verifies the signature for the specified data. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Error | This event is fired for information about errors during data delivery. |
| Progress | Fired as progress is made. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| AppendSecret | An optional string to append to the secret agreement. |
| CNGECDHKey | The CNG ECDH key. |
| CNGECDSAKey | The CNG ECDSA key. |
| ConcatAlgorithmId | The AlgorithmId subfield of the OtherInfo field. |
| ConcatHashAlgorithm | The hash algorithm to use when ComputeSecretKDF is Concat. |
| ConcatPartyUInfo | The PartyUInfo subfield of the OtherInfo field. |
| ConcatPartyVInfo | The PartyVInfo subfield of the OtherInfo field. |
| ConcatSuppPrivInfo | The SuppPrivInfo subfield of the OtherInfo field. |
| ConcatSuppPubInfo | The SuppPubInfo subfield of the OtherInfo field. |
| ECDSASignatureFormat | The format of the HashSignature when using ECDSA keys. |
| EdDSAContext | A hex encoded string holding the bytes of the context when signing or verifying with Ed25519ctx. |
| EncryptionKeySize | The encryption key size. |
| HMACKey | A key to use when generating a Hash-based Message Authentication Code (HMAC). |
| HMACKeySize | The HMAC key size to be used during encryption. |
| HMACOptionalInfo | Optional data to be used during encryption and decryption during the HMAC step. |
| KDFOptionalInfo | Optional data to be used during encryption and decryption during the key derivation step. |
| PrependSecret | An optional string to prepend to the secret agreement. |
| StrictKeyValidation | Whether to validate provided public keys based on private keys. |
| TLSLabel | The TLS PRF label. |
| TLSSeed | The TLS PRF Seed. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Tells the control whether or not to use the system security libraries or an internal implementation. |
CertEffectiveDate Property (ECC Control)
This is the date on which this certificate becomes valid.
Syntax
ecccontrol.CertEffectiveDate
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
CertExpirationDate Property (ECC Control)
This is the date the certificate expires.
Syntax
ecccontrol.CertExpirationDate
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
CertExtendedKeyUsage Property (ECC Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
ecccontrol.CertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
CertFingerprint Property (ECC Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
ecccontrol.CertFingerprint
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
CertFingerprintSHA1 Property (ECC Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
ecccontrol.CertFingerprintSHA1
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
CertFingerprintSHA256 Property (ECC Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
ecccontrol.CertFingerprintSHA256
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
CertIssuer Property (ECC Control)
This is the issuer of the certificate.
Syntax
ecccontrol.CertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
CertPrivateKey Property (ECC Control)
This is the private key of the certificate (if available).
Syntax
ecccontrol.CertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
CertPrivateKeyAvailable Property (ECC Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
ecccontrol.CertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
CertPrivateKeyContainer Property (ECC Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
ecccontrol.CertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
CertPublicKey Property (ECC Control)
This is the public key of the certificate.
Syntax
ecccontrol.CertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
CertPublicKeyAlgorithm Property (ECC Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
ecccontrol.CertPublicKeyAlgorithm
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
CertPublicKeyLength Property (ECC Control)
This is the length of the certificate's public key (in bits).
Syntax
ecccontrol.CertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
CertSerialNumber Property (ECC Control)
This is the serial number of the certificate encoded as a string.
Syntax
ecccontrol.CertSerialNumber
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
CertSignatureAlgorithm Property (ECC Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
ecccontrol.CertSignatureAlgorithm
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
CertStore Property (ECC Control)
This is the name of the certificate store for the client certificate.
Syntax
ecccontrol.CertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.
Data Type
Binary String
CertStorePassword Property (ECC Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ecccontrol.CertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
CertStoreType Property (ECC Control)
This is the type of certificate store for this certificate.
Syntax
ecccontrol.CertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 (PKCS12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
CertSubjectAltNames Property (ECC Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
ecccontrol.CertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
CertThumbprintMD5 Property (ECC Control)
This property contains the MD5 hash of the certificate.
Syntax
ecccontrol.CertThumbprintMD5
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
CertThumbprintSHA1 Property (ECC Control)
This property contains the SHA-1 hash of the certificate.
Syntax
ecccontrol.CertThumbprintSHA1
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
CertThumbprintSHA256 Property (ECC Control)
This property contains the SHA-256 hash of the certificate.
Syntax
ecccontrol.CertThumbprintSHA256
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
CertUsage Property (ECC Control)
This property contains the text description of UsageFlags .
Syntax
ecccontrol.CertUsage
Default Value
""
Remarks
This property contains the text description of CertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
CertUsageFlags Property (ECC Control)
This property contains the flags that show intended use for the certificate.
Syntax
ecccontrol.CertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the CertUsage property for a text representation of CertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
CertVersion Property (ECC Control)
This property contains the certificate's version number.
Syntax
ecccontrol.CertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
CertSubject Property (ECC Control)
This is the subject of the certificate used for client authentication.
Syntax
ecccontrol.CertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
CertEncoded Property (ECC Control)
This is the certificate (PEM/base64 encoded).
Syntax
ecccontrol.CertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.
This property is not available at design time.
Data Type
Binary String
ComputeSecretKDF Property (ECC Control)
The key derivation function.
Syntax
ecccontrol.ComputeSecretKDF[=integer]
Possible Values
ekdSHA1(0), ekdSHA256(1), ekdSHA384(2), ekdSHA512(3), ekdMD2(4), ekdMD4(5), ekdMD5(6), ekdHMACSHA1(7), ekdHMACSHA256(8), ekdHMACSHA384(9), ekdHMACSHA512(10), ekdHMACMD5(11), ekdTLS(12), ekdConcat(13)
Default Value
1
Remarks
This property specifies the key derivation function (KDF) and algorithm to use when calling ComputeSecret.
Possible values are:
| 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:
- ConcatAlgorithmId (required)
- ConcatPartyUInfo (required)
- ConcatPartyVInfo (required)
- ConcatSuppPubInfo
- ConcatSuppPrivInfo
- ConcatHashAlgorithm
Data Type
Integer
EncryptionAlgorithm Property (ECC Control)
The encryption algorithm to use.
Syntax
ecccontrol.EncryptionAlgorithm[=integer]
Possible Values
iesAES(0), iesTripleDES(1), iesXOR(2)
Default Value
0
Remarks
This setting specifies the encryption algorithm to use when Encrypt is called. This must also be set before calling Decrypt to match the algorithm used during the initial encryption.
Possible values are:
- 0 (iesAES - default)
- 1 (iesTripleDES)
- 2 (iesXOR)
AES Notes
When EncryptionAlgorithm is set to iesAES, AES CBC with a default key size of 256 bits is used. To specify a different key size, set EncryptionKeySize.Data Type
Integer
HashAlgorithm Property (ECC Control)
The hash algorithm used for hash computation.
Syntax
ecccontrol.HashAlgorithm[=integer]
Possible Values
ehaSHA1(0), ehaSHA224(1), ehaSHA256(2), ehaSHA384(3), ehaSHA512(4), ehaMD2(5), ehaMD4(6), ehaMD5(7), ehaMD5SHA1(8), ehaRIPEMD160(9)
Default Value
2
Remarks
This property specifies the hash algorithm used for hash computation. This is only applicable when calling Sign or VerifySignature and KeyAlgorithm specifies a ECDSA key (NIST, Koblitz, or Brainpool curve). Possible values are:
| 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.
Data Type
Integer
HashEdDSA Property (ECC Control)
Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key.
Syntax
ecccontrol.HashEdDSA[=boolean]
Default Value
False
Remarks
This setting specifies whether to use the HashEdDSA algorithm when signing and verifying with Ed25519 or Ed448 keys.
If set to True, the control will use the HashEdDSA algorithm (Ed25519ph or Ed448ph) when signing and verifying. When using a HashEdDSA algorithm, the input is pre-hashed and supports a single pass over the data during the signing operation.
If set to False (default), the control will use the PureEdDSA algorithm (Ed25519 or Ed448) when signing. The PureEdDSA requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure.
This property is only applicable when calling Sign and KeyAlgorithm is set to Ed25519 or Ed448.
If this property is set before calling Sign, it must be set before calling VerifySignature.
Data Type
Boolean
HashSignature Property (ECC Control)
The hash signature.
Syntax
ecccontrol.HashSignature[=string]
Default Value
""
Remarks
This property holds the computed hash signature. This is populated after calling Sign. This must be set before calling VerifySignature.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .HashSignatureB.
Data Type
Binary String
HashValue Property (ECC Control)
The hash value of the data.
Syntax
ecccontrol.HashValue[=string]
Default Value
""
Remarks
This property holds the computed hash value for the specified data. This is populated when calling Sign or VerifySignature when an input file is specified by setting InputFile or InputMessage.
Pre-existing hash values may be set to this property before calling Sign or VerifySignature. If you know the hash value prior to using the control, you may specify the pre-computed hash value here.
This setting is not applicable to PureEdDSA algorithms. If KeyAlgorithm is Ed25519 or Ed448 and HashEdDSA is False (default), the PureEdDSA algorithm is used and HashValue is not applicable.
Hash Notes
The control will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by InputFile or InputMessage, the hash will be recomputed when calling Sign or VerifySignature. If the HashValue property is set, the control will only sign the hash or verify the hash signature. Setting InputFile or InputMessage clears the HashValue property. Setting the HashValue property clears the input file selection.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .HashValueB.
Data Type
Binary String
HMACAlgorithm Property (ECC Control)
The HMAC algorithm to use during encryption.
Syntax
ecccontrol.HMACAlgorithm[=integer]
Possible Values
iesHMACSHA1(0), iesHMACSHA224(1), iesHMACSHA256(2), iesHMACSHA384(3), iesHMACSHA512(4), iesHMACRIPEMD160(5)
Default Value
2
Remarks
This property specifies the HMAC algorithm to use when encrypting. The HMAC algorithm is used when Encrypt and Decrypt are called to protect and verify data. Possible values are:
- 0 (iesHMACSHA1)
- 1 (iesHMACSHA224)
- 2 (iesHMACSHA256 - Default)
- 3 (iesHMACSHA384)
- 4 (iesHMACSHA512)
- 5 (iesHMACRIPEMD160)
This property is only applicable when calling Encrypt or Decrypt.
Data Type
Integer
InputFile Property (ECC Control)
The file to process.
Syntax
ecccontrol.InputFile[=string]
Default Value
""
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
InputMessage Property (ECC Control)
The message to process.
Syntax
ecccontrol.InputMessage[=string]
Default Value
""
Remarks
This property specifies the message to be processed.
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .InputMessageB.
Data Type
Binary String
IV Property (ECC Control)
The initialization vector (IV) used when encrypting.
Syntax
ecccontrol.IV[=string]
Default Value
""
Remarks
This property optionally specifies an IV to be used when calling Encrypt or Decrypt. If specified, the IV is used by EncryptionAlgorithm during encryption.
If not specified, the control will create an IV filled with null bytes (zeros). Since the encryption key is only used once, the use of null bytes in the IV is considered acceptable and is a standard practice.
The length of the IV should be as follows:
| EncryptionAlgorithm | IV Length (in bytes) |
| AES | 16 |
| 3DES | 8 |
This setting is not applicable when EncryptionAlgorithm is set to XOR.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .IVB.
Data Type
Binary String
KDF Property (ECC Control)
The key derivation function used during encryption and decryption.
Syntax
ecccontrol.KDF[=string]
Default Value
"KDF2"
Remarks
This property specifies the key derivation function (KDF) to use when encrypting and decrypting. Possible values are:
- "KDF1"
- "KDF2" (default)
This property is only applicable when calling Encrypt or Decrypt.
Data Type
String
KDFHashAlgorithm Property (ECC Control)
The KDF hash algorithm to use when encrypting and decrypting.
Syntax
ecccontrol.KDFHashAlgorithm[=integer]
Possible Values
iesSHA1(0), iesSHA224(1), iesSHA256(2), iesSHA384(3), iesSHA512(4)
Default Value
2
Remarks
This property specifies the hash algorithm to use when deriving a key using the specified KDF. Possible values are:
- 0 (iesSHA1)
- 1 (iesSHA224)
- 2 (iesSHA256)
- 3 (iesSHA384)
- 4 (iesSHA512)
This property is only applicable when calling Encrypt or Decrypt.
Data Type
Integer
KeyAlgorithm Property (ECC Control)
This property holds the algorithm associated with the key.
Syntax
ecccontrol.KeyAlgorithm[=integer]
Possible Values
eaSecp256r1(0), eaSecp384r1(1), eaSecp521r1(2), eaEd25519(3), eaEd448(4), eaX25519(5), eaX448(6), eaSecp160k1(7), eaSecp192k1(8), eaSecp224k1(9), eaSecp256k1(10), eaBrainpoolP160r1(11), eaBrainpoolP192r1(12), eaBrainpoolP224r1(13), eaBrainpoolP256r1(14), eaBrainpoolP320r1(15), eaBrainpoolP384r1(16), eaBrainpoolP512r1(17), eaBrainpoolP160t1(18), eaBrainpoolP192t1(19), eaBrainpoolP224t1(20), eaBrainpoolP256t1(21), eaBrainpoolP320t1(22), eaBrainpoolP384t1(23), eaBrainpoolP512t1(24)
Default Value
0
Remarks
This property holds the algorithm associated with the key. Possible values are:
- 0 (eaSecp256r1)
- 1 (eaSecp384r1)
- 2 (eaSecp521r1)
- 3 (eaEd25519)
- 4 (eaEd448)
- 5 (eaX25519)
- 6 (eaX448)
- 7 (eaSecp160k1)
- 8 (eaSecp192k1)
- 9 (eaSecp224k1)
- 10 (eaSecp256k1)
- 11 (eaBrainpoolP160r1)
- 12 (eaBrainpoolP192r1)
- 13 (eaBrainpoolP224r1)
- 14 (eaBrainpoolP256r1)
- 15 (eaBrainpoolP320r1)
- 16 (eaBrainpoolP384r1)
- 17 (eaBrainpoolP512r1)
- 18 (eaBrainpoolP160t1)
- 19 (eaBrainpoolP192t1)
- 20 (eaBrainpoolP224t1)
- 21 (eaBrainpoolP256t1)
- 22 (eaBrainpoolP320t1)
- 23 (eaBrainpoolP384t1)
- 24 (eaBrainpoolP512t1)
When assigning a key using the PEM formatted KeyPrivateKey and KeyPublicKey, the KeyAlgorithm property will be automatically updated with the key algorithm.
When assigning a key using the raw key parameters (KeyK, KeyRx, and KeyRy for NIST or KeyXPk, and KeyXSk for Curve25519/Curve448), the KeyAlgorithm property must be set manually to the key algorithm.
The following table summarizes the supported operations for keys created with each algorithm:
| KeyAlgorithm | Supported Operations |
| secp256r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp384r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp521r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| X25519 | ECDH (ComputeSecret) |
| X448 | ECDH (ComputeSecret) |
| Ed25519 | EdDSA (Sign and VerifySignature) |
| Ed448 | EdDSA (Sign and VerifySignature) |
| secp160k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp192k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp224k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp256k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP160r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP192r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP224r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP256r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP320r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP384r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP512r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP160t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP192t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP224t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP256t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP320t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP384t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP512t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
Data Type
Integer
KeyK Property (ECC Control)
Represents the private key (K) parameter.
Syntax
ecccontrol.KeyK[=string]
Default Value
""
Remarks
Represents the private key (K) parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyKB.
Data Type
Binary String
KeyPrivateKey Property (ECC Control)
This property is a PEM formatted private key.
Syntax
ecccontrol.KeyPrivateKey[=string]
Default Value
""
Remarks
This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.
Data Type
String
KeyPublicKey Property (ECC Control)
This property is a PEM formatted public key.
Syntax
ecccontrol.KeyPublicKey[=string]
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
KeyRx Property (ECC Control)
Represents the public key's Rx parameter.
Syntax
ecccontrol.KeyRx[=string]
Default Value
""
Remarks
Represents the public key's Rx parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyRxB.
Data Type
Binary String
KeyRy Property (ECC Control)
Represents the public key's Ry parameter.
Syntax
ecccontrol.KeyRy[=string]
Default Value
""
Remarks
Represents the public key's Ry parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyRyB.
Data Type
Binary String
KeyXPk Property (ECC Control)
Holds the public key data.
Syntax
ecccontrol.KeyXPk[=string]
Default Value
""
Remarks
Holds the public key data.
Note: This value is only applicable when using Curve25519 or Curve448.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyXPkB.
Data Type
Binary String
KeyXSk Property (ECC Control)
Holds the private key data.
Syntax
ecccontrol.KeyXSk[=string]
Default Value
""
Remarks
Holds the private key data.
Note: This value is only applicable when using Curve25519 or Curve448.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyXSkB.
Data Type
Binary String
OutputFile Property (ECC Control)
The output file when encrypting or decrypting.
Syntax
ecccontrol.OutputFile[=string]
Default Value
""
Remarks
This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.
This property is only applicable to Encrypt and Decrypt.
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Data Type
String
OutputMessage Property (ECC Control)
The output message when encrypting or decrypting.
Syntax
ecccontrol.OutputMessage
Default Value
""
Remarks
This property will be populated with the output after calling Encrypt or Decrypt if OutputFile is not set.
This property is only applicable to Encrypt and Decrypt.
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .OutputMessageB.
This property is read-only and not available at design time.
Data Type
Binary String
Overwrite Property (ECC Control)
Indicates whether or not the control should overwrite files.
Syntax
ecccontrol.Overwrite[=boolean]
Default Value
False
Remarks
This property indicates whether or not the control will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.
Data Type
Boolean
RecipientCertEffectiveDate Property (ECC Control)
This is the date on which this certificate becomes valid.
Syntax
ecccontrol.RecipientCertEffectiveDate
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
RecipientCertExpirationDate Property (ECC Control)
This is the date the certificate expires.
Syntax
ecccontrol.RecipientCertExpirationDate
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
RecipientCertExtendedKeyUsage Property (ECC Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
ecccontrol.RecipientCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
RecipientCertFingerprint Property (ECC Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
ecccontrol.RecipientCertFingerprint
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
RecipientCertFingerprintSHA1 Property (ECC Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
ecccontrol.RecipientCertFingerprintSHA1
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
RecipientCertFingerprintSHA256 Property (ECC Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
ecccontrol.RecipientCertFingerprintSHA256
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
RecipientCertIssuer Property (ECC Control)
This is the issuer of the certificate.
Syntax
ecccontrol.RecipientCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
RecipientCertPrivateKey Property (ECC Control)
This is the private key of the certificate (if available).
Syntax
ecccontrol.RecipientCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The RecipientCertPrivateKey may be available but not exportable. In this case, RecipientCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
RecipientCertPrivateKeyAvailable Property (ECC Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
ecccontrol.RecipientCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
RecipientCertPrivateKeyContainer Property (ECC Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
ecccontrol.RecipientCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the RecipientCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
RecipientCertPublicKey Property (ECC Control)
This is the public key of the certificate.
Syntax
ecccontrol.RecipientCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
RecipientCertPublicKeyAlgorithm Property (ECC Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
ecccontrol.RecipientCertPublicKeyAlgorithm
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
RecipientCertPublicKeyLength Property (ECC Control)
This is the length of the certificate's public key (in bits).
Syntax
ecccontrol.RecipientCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
RecipientCertSerialNumber Property (ECC Control)
This is the serial number of the certificate encoded as a string.
Syntax
ecccontrol.RecipientCertSerialNumber
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
RecipientCertSignatureAlgorithm Property (ECC Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
ecccontrol.RecipientCertSignatureAlgorithm
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
RecipientCertStore Property (ECC Control)
This is the name of the certificate store for the client certificate.
Syntax
ecccontrol.RecipientCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.
RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertStoreB.
Data Type
Binary String
RecipientCertStorePassword Property (ECC Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ecccontrol.RecipientCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
RecipientCertStoreType Property (ECC Control)
This is the type of certificate store for this certificate.
Syntax
ecccontrol.RecipientCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 (PKCS12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 RecipientCertStore and set RecipientCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
RecipientCertSubjectAltNames Property (ECC Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
ecccontrol.RecipientCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
RecipientCertThumbprintMD5 Property (ECC Control)
This property contains the MD5 hash of the certificate.
Syntax
ecccontrol.RecipientCertThumbprintMD5
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
RecipientCertThumbprintSHA1 Property (ECC Control)
This property contains the SHA-1 hash of the certificate.
Syntax
ecccontrol.RecipientCertThumbprintSHA1
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
RecipientCertThumbprintSHA256 Property (ECC Control)
This property contains the SHA-256 hash of the certificate.
Syntax
ecccontrol.RecipientCertThumbprintSHA256
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
RecipientCertUsage Property (ECC Control)
This property contains the text description of UsageFlags .
Syntax
ecccontrol.RecipientCertUsage
Default Value
""
Remarks
This property contains the text description of RecipientCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
RecipientCertUsageFlags Property (ECC Control)
This property contains the flags that show intended use for the certificate.
Syntax
ecccontrol.RecipientCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of RecipientCertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
RecipientCertVersion Property (ECC Control)
This property contains the certificate's version number.
Syntax
ecccontrol.RecipientCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
RecipientCertSubject Property (ECC Control)
This is the subject of the certificate used for client authentication.
Syntax
ecccontrol.RecipientCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
RecipientCertEncoded Property (ECC Control)
This is the certificate (PEM/base64 encoded).
Syntax
ecccontrol.RecipientCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.
When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertEncodedB.
This property is not available at design time.
Data Type
Binary String
RecipientKeyAlgorithm Property (ECC Control)
This property holds the algorithm associated with the key.
Syntax
ecccontrol.RecipientKeyAlgorithm[=integer]
Possible Values
eaSecp256r1(0), eaSecp384r1(1), eaSecp521r1(2), eaEd25519(3), eaEd448(4), eaX25519(5), eaX448(6), eaSecp160k1(7), eaSecp192k1(8), eaSecp224k1(9), eaSecp256k1(10), eaBrainpoolP160r1(11), eaBrainpoolP192r1(12), eaBrainpoolP224r1(13), eaBrainpoolP256r1(14), eaBrainpoolP320r1(15), eaBrainpoolP384r1(16), eaBrainpoolP512r1(17), eaBrainpoolP160t1(18), eaBrainpoolP192t1(19), eaBrainpoolP224t1(20), eaBrainpoolP256t1(21), eaBrainpoolP320t1(22), eaBrainpoolP384t1(23), eaBrainpoolP512t1(24)
Default Value
0
Remarks
This property holds the algorithm associated with the key. Possible values are:
- 0 (eaSecp256r1)
- 1 (eaSecp384r1)
- 2 (eaSecp521r1)
- 3 (eaEd25519)
- 4 (eaEd448)
- 5 (eaX25519)
- 6 (eaX448)
- 7 (eaSecp160k1)
- 8 (eaSecp192k1)
- 9 (eaSecp224k1)
- 10 (eaSecp256k1)
- 11 (eaBrainpoolP160r1)
- 12 (eaBrainpoolP192r1)
- 13 (eaBrainpoolP224r1)
- 14 (eaBrainpoolP256r1)
- 15 (eaBrainpoolP320r1)
- 16 (eaBrainpoolP384r1)
- 17 (eaBrainpoolP512r1)
- 18 (eaBrainpoolP160t1)
- 19 (eaBrainpoolP192t1)
- 20 (eaBrainpoolP224t1)
- 21 (eaBrainpoolP256t1)
- 22 (eaBrainpoolP320t1)
- 23 (eaBrainpoolP384t1)
- 24 (eaBrainpoolP512t1)
When assigning a key using the PEM formatted RecipientKeyPrivateKey and RecipientKeyPublicKey, the RecipientKeyAlgorithm property will be automatically updated with the key algorithm.
When assigning a key using the raw key parameters (RecipientKeyK, RecipientKeyRx, and RecipientKeyRy for NIST or RecipientKeyXPk, and RecipientKeyXSk for Curve25519/Curve448), the RecipientKeyAlgorithm property must be set manually to the key algorithm.
The following table summarizes the supported operations for keys created with each algorithm:
| KeyAlgorithm | Supported Operations |
| secp256r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp384r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp521r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| X25519 | ECDH (ComputeSecret) |
| X448 | ECDH (ComputeSecret) |
| Ed25519 | EdDSA (Sign and VerifySignature) |
| Ed448 | EdDSA (Sign and VerifySignature) |
| secp160k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp192k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp224k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp256k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP160r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP192r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP224r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP256r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP320r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP384r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP512r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP160t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP192t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP224t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP256t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP320t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP384t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP512t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
Data Type
Integer
RecipientKeyPublicKey Property (ECC Control)
This property is a PEM formatted public key.
Syntax
ecccontrol.RecipientKeyPublicKey[=string]
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
RecipientKeyRx Property (ECC Control)
Represents the public key's Rx parameter.
Syntax
ecccontrol.RecipientKeyRx[=string]
Default Value
""
Remarks
Represents the public key's Rx parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyRxB.
Data Type
Binary String
RecipientKeyRy Property (ECC Control)
Represents the public key's Ry parameter.
Syntax
ecccontrol.RecipientKeyRy[=string]
Default Value
""
Remarks
Represents the public key's Ry parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyRyB.
Data Type
Binary String
RecipientKeyXPk Property (ECC Control)
Holds the public key data.
Syntax
ecccontrol.RecipientKeyXPk[=string]
Default Value
""
Remarks
Holds the public key data.
Note: This value is only applicable when using Curve25519 or Curve448.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientKeyXPkB.
Data Type
Binary String
SharedSecret Property (ECC Control)
The computed shared secret.
Syntax
ecccontrol.SharedSecret
Default Value
""
Remarks
This property holds the shared secret computed by ComputeSecret.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SharedSecretB.
This property is read-only.
Data Type
Binary String
SignerCertEffectiveDate Property (ECC Control)
This is the date on which this certificate becomes valid.
Syntax
ecccontrol.SignerCertEffectiveDate
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SignerCertExpirationDate Property (ECC Control)
This is the date the certificate expires.
Syntax
ecccontrol.SignerCertExpirationDate
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SignerCertExtendedKeyUsage Property (ECC Control)
This is a comma-delimited list of extended key usage identifiers.
Syntax
ecccontrol.SignerCertExtendedKeyUsage
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SignerCertFingerprint Property (ECC Control)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
ecccontrol.SignerCertFingerprint
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SignerCertFingerprintSHA1 Property (ECC Control)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
ecccontrol.SignerCertFingerprintSHA1
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SignerCertFingerprintSHA256 Property (ECC Control)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
ecccontrol.SignerCertFingerprintSHA256
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SignerCertIssuer Property (ECC Control)
This is the issuer of the certificate.
Syntax
ecccontrol.SignerCertIssuer
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SignerCertPrivateKey Property (ECC Control)
This is the private key of the certificate (if available).
Syntax
ecccontrol.SignerCertPrivateKey
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SignerCertPrivateKeyAvailable Property (ECC Control)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
ecccontrol.SignerCertPrivateKeyAvailable
Default Value
False
Remarks
This property shows whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SignerCertPrivateKeyContainer Property (ECC Control)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
ecccontrol.SignerCertPrivateKeyContainer
Default Value
""
Remarks
This is the name of the SignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SignerCertPublicKey Property (ECC Control)
This is the public key of the certificate.
Syntax
ecccontrol.SignerCertPublicKey
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SignerCertPublicKeyAlgorithm Property (ECC Control)
This property contains the textual description of the certificate's public key algorithm.
Syntax
ecccontrol.SignerCertPublicKeyAlgorithm
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SignerCertPublicKeyLength Property (ECC Control)
This is the length of the certificate's public key (in bits).
Syntax
ecccontrol.SignerCertPublicKeyLength
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SignerCertSerialNumber Property (ECC Control)
This is the serial number of the certificate encoded as a string.
Syntax
ecccontrol.SignerCertSerialNumber
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SignerCertSignatureAlgorithm Property (ECC Control)
The property contains the text description of the certificate's signature algorithm.
Syntax
ecccontrol.SignerCertSignatureAlgorithm
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SignerCertStore Property (ECC Control)
This is the name of the certificate store for the client certificate.
Syntax
ecccontrol.SignerCertStore[=string]
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertStoreB.
Data Type
Binary String
SignerCertStorePassword Property (ECC Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ecccontrol.SignerCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SignerCertStoreType Property (ECC Control)
This is the type of certificate store for this certificate.
Syntax
ecccontrol.SignerCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 (PKCS12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.
To use a security key, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 SignerCertStore and set SignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 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. |
Data Type
Integer
SignerCertSubjectAltNames Property (ECC Control)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
ecccontrol.SignerCertSubjectAltNames
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SignerCertThumbprintMD5 Property (ECC Control)
This property contains the MD5 hash of the certificate.
Syntax
ecccontrol.SignerCertThumbprintMD5
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SignerCertThumbprintSHA1 Property (ECC Control)
This property contains the SHA-1 hash of the certificate.
Syntax
ecccontrol.SignerCertThumbprintSHA1
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SignerCertThumbprintSHA256 Property (ECC Control)
This property contains the SHA-256 hash of the certificate.
Syntax
ecccontrol.SignerCertThumbprintSHA256
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SignerCertUsage Property (ECC Control)
This property contains the text description of UsageFlags .
Syntax
ecccontrol.SignerCertUsage
Default Value
""
Remarks
This property contains the text description of SignerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SignerCertUsageFlags Property (ECC Control)
This property contains the flags that show intended use for the certificate.
Syntax
ecccontrol.SignerCertUsageFlags
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SignerCertVersion Property (ECC Control)
This property contains the certificate's version number.
Syntax
ecccontrol.SignerCertVersion
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SignerCertSubject Property (ECC Control)
This is the subject of the certificate used for client authentication.
Syntax
ecccontrol.SignerCertSubject[=string]
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, or E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SignerCertEncoded Property (ECC Control)
This is the certificate (PEM/base64 encoded).
Syntax
ecccontrol.SignerCertEncoded[=string]
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SignerKeyAlgorithm Property (ECC Control)
This property holds the algorithm associated with the key.
Syntax
ecccontrol.SignerKeyAlgorithm[=integer]
Possible Values
eaSecp256r1(0), eaSecp384r1(1), eaSecp521r1(2), eaEd25519(3), eaEd448(4), eaX25519(5), eaX448(6), eaSecp160k1(7), eaSecp192k1(8), eaSecp224k1(9), eaSecp256k1(10), eaBrainpoolP160r1(11), eaBrainpoolP192r1(12), eaBrainpoolP224r1(13), eaBrainpoolP256r1(14), eaBrainpoolP320r1(15), eaBrainpoolP384r1(16), eaBrainpoolP512r1(17), eaBrainpoolP160t1(18), eaBrainpoolP192t1(19), eaBrainpoolP224t1(20), eaBrainpoolP256t1(21), eaBrainpoolP320t1(22), eaBrainpoolP384t1(23), eaBrainpoolP512t1(24)
Default Value
0
Remarks
This property holds the algorithm associated with the key. Possible values are:
- 0 (eaSecp256r1)
- 1 (eaSecp384r1)
- 2 (eaSecp521r1)
- 3 (eaEd25519)
- 4 (eaEd448)
- 5 (eaX25519)
- 6 (eaX448)
- 7 (eaSecp160k1)
- 8 (eaSecp192k1)
- 9 (eaSecp224k1)
- 10 (eaSecp256k1)
- 11 (eaBrainpoolP160r1)
- 12 (eaBrainpoolP192r1)
- 13 (eaBrainpoolP224r1)
- 14 (eaBrainpoolP256r1)
- 15 (eaBrainpoolP320r1)
- 16 (eaBrainpoolP384r1)
- 17 (eaBrainpoolP512r1)
- 18 (eaBrainpoolP160t1)
- 19 (eaBrainpoolP192t1)
- 20 (eaBrainpoolP224t1)
- 21 (eaBrainpoolP256t1)
- 22 (eaBrainpoolP320t1)
- 23 (eaBrainpoolP384t1)
- 24 (eaBrainpoolP512t1)
When assigning a key using the PEM formatted SignerKeyPrivateKey and SignerKeyPublicKey, the SignerKeyAlgorithm property will be automatically updated with the key algorithm.
When assigning a key using the raw key parameters (SignerKeyK, SignerKeyRx, and SignerKeyRy for NIST or SignerKeyXPk, and SignerKeyXSk for Curve25519/Curve448), the SignerKeyAlgorithm property must be set manually to the key algorithm.
The following table summarizes the supported operations for keys created with each algorithm:
| KeyAlgorithm | Supported Operations |
| secp256r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp384r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp521r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| X25519 | ECDH (ComputeSecret) |
| X448 | ECDH (ComputeSecret) |
| Ed25519 | EdDSA (Sign and VerifySignature) |
| Ed448 | EdDSA (Sign and VerifySignature) |
| secp160k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp192k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp224k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| secp256k1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP160r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP192r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP224r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP256r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP320r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP384r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP512r1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP160t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP192t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP224t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP256t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP320t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP384t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
| brainpoolP512t1 | ECDH/ECIES/ECDSA (ComputeSecret, Encrypt, Decrypt, Sign, and VerifySignature) |
Data Type
Integer
SignerKeyPublicKey Property (ECC Control)
This property is a PEM formatted public key.
Syntax
ecccontrol.SignerKeyPublicKey[=string]
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
SignerKeyRx Property (ECC Control)
Represents the public key's Rx parameter.
Syntax
ecccontrol.SignerKeyRx[=string]
Default Value
""
Remarks
Represents the public key's Rx parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyRxB.
Data Type
Binary String
SignerKeyRy Property (ECC Control)
Represents the public key's Ry parameter.
Syntax
ecccontrol.SignerKeyRy[=string]
Default Value
""
Remarks
Represents the public key's Ry parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyRyB.
Data Type
Binary String
SignerKeyXPk Property (ECC Control)
Holds the public key data.
Syntax
ecccontrol.SignerKeyXPk[=string]
Default Value
""
Remarks
Holds the public key data.
Note: This value is only applicable when using Curve25519 or Curve448.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerKeyXPkB.
Data Type
Binary String
UseHex Property (ECC Control)
Whether binary values are hex encoded.
Syntax
ecccontrol.UseHex[=boolean]
Default Value
False
Remarks
This setting specifies whether various calculated values are hex encoded. If set to False (default), all data is provided as-is with no encoding.
If set to True, certain properties are hex encoded when populated for ease of display, transport, and storage.
Compute Secret Notes
This property specifies whether SharedSecret is hex encoded when ComputeSecret is called.
Sign and Verify Notes
This property specifies whether HashValue and HashSignature are hex encoded.
If set to True, when Sign is called the control will compute the hash for the specified file and populate HashValue with the hex encoded hash value. It will then create the hash signature and populate HashSignature with the hex encoded hash signature value. If HashValue is specified directly, it must be a hex encoded value.
If set to True, when VerifySignature is called the control will compute the hash value for the specified file and populate HashValue with the hex encoded hash value. It will then hex decode HashSignature and verify the signature. HashSignature must hold a hex encoded value. If HashValue is specified directly, it must be a hex encoded value.
Encrypt and Decrypt Notes
If set to True, when Encrypt is called the control will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.
If set to True, when Decrypt is called the control will expect InputMessage or InputFile to hold hex encoded data. The control will then hex decode the data and perform decryption as normal.
Data Type
Boolean
ComputeSecret Method (ECC Control)
Computes a shared secret.
Syntax
ecccontrol.ComputeSecret
Remarks
This method computes a shared secret using Elliptic Curve Diffie Hellman (ECDH).
When this method is called, the control will use the public key specified by RecipientKeyPublicKey and the private key specified by Key to compute a shared secret, or secret agreement. The ComputeSecretKDF property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by SharedSecret. The following properties are applicable when calling this method:
- Key (required)
- RecipientKeyPublicKey (required)
- ComputeSecretKDF (optional)
See ComputeSecretKDF for details on advanced settings that may be applicable for the chosen algorithm.
Keys created with the Ed25519 and Ed448 algorithms are not supported when calling this method.
Compute Secret Example
//Create a key for Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("X25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Create a key for Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("X25519");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Note: the public keys must be exchanged between parties by some mechanism
//Create the shared secret on Party 1
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv; //Private key of this party
ecc1.RecipientKey.PublicKey = ecc2_pub; //Public key of other party
ecc1.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc1.ComputeSecret();
Console.WriteLine(ecc1.SharedSecret);
//Create the shared secret on Party 2
ecc2.Reset();
ecc2.Key.PrivateKey = ecc2_priv; //Private key of this party
ecc2.RecipientKey.PublicKey = ecc1_pub; //Public key of other party
ecc2.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc2.ComputeSecret();
Console.WriteLine(ecc2.SharedSecret); //This will match the shared secret created by ecc1.
Config Method (ECC Control)
This method sets or retrieves a configuration setting.
Syntax
ecccontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CreateKey Method (ECC Control)
Creates a new key.
Syntax
ecccontrol.CreateKey KeyAlgorithm
Remarks
CreateKey creates a new public and private key.
When this method is called, Key is populated with the generated key. The KeyPublicKey and KeyPrivateKey properties hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.
The KeyAlgorithm parameter specifies the algorithm for which the key is intended to be used. Possible values are:
NIST, Koblitz, and Brainpool Curve Notes
Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters.
The public key consists of the following parameters:
The private key consists of one value:
Curve25519 and Curve448 Notes
Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.
KeyXPk holds the public key.
KeyXSk holds the private key.
Create Key Example (secp256r1 - PEM)
//Create a key using secp256r1
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (secp256r1 - Raw Key Params)
//Create a key using secp256r1 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
byte[] K = ecc.Key.KB; //Private key param
byte[] Rx = ecc.Key.RxB; //Public key param
byte[] Ry = ecc.Key.RyB; //Public key param
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaSecp256r1; //This MUST be set manually when using key params directly
ecc.Key.KB = K;
ecc.Key.RxB = Rx;
ecc.Key.RyB = Ry;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (Ed25519 - PEM)
//Create a key using Ed25519
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Create Key Example (Ed25519 - Raw Key Params)
//Create a key using Ed25519 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
byte[] XPk = ecc.Key.XPkB; //Public key data
byte[] XSk = ecc.Key.XSkB; //Secret key data
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaEd25519; //This MUST be set manually when using key params directly
ecc.Key.XPkB = XPk;
ecc.Key.XSkB = XSk;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Decrypt Method (ECC Control)
Decrypted the specified data.
Syntax
ecccontrol.Decrypt
Remarks
Decrypt decrypts the specified data with the ECDSA private key specified in Key.
Decryption is performed using ECIES which requires an ECDSA key. Key must contain an ECDSA key. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See CreateKey for details about key creation and algorithms.
When this method is called, the control will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set UseHex to True.
The following properties are applicable when calling this method:
- EncryptionAlgorithm
- HMACAlgorithm
- HMACOptionalInfo
- HMACKeySize
- IV
- KDF
- KDFHashAlgorithm
- KDFOptionalInfo
- UseHex
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt Method (ECC Control)
Encrypts the specified data.
Syntax
ecccontrol.Encrypt
Remarks
Encrypt encrypts the specified data with the ECDSA public key specified in RecipientKey.
Encryption is performed using ECIES which requires an ECDSA key. RecipientKey must contain an ECDSA key. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See CreateKey for details about key creation and algorithms.
When this method is called, the control will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output, set UseHex to True.
The following properties are applicable when calling this method:
- EncryptionAlgorithm
- HMACAlgorithm
- HMACOptionalInfo
- HMACKeySize
- IV
- KDF
- KDFHashAlgorithm
- KDFOptionalInfo
- UseHex
Input and Output Properties
The control will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Reset Method (ECC Control)
Resets the control.
Syntax
ecccontrol.Reset
Remarks
When called, the control will reset all of its properties to their default values.
Sign Method (ECC Control)
Creates a hash signature using ECDSA or EdDSA.
Syntax
ecccontrol.Sign
Remarks
Sign will create a hash signature using ECDSA or EdDSA. The control will use the key specified by Key to hash the input data and sign the resulting hash.
Key must contain a private key created with a valid ECDSA or EdDSA algorithm. KeyAlgorithm is used to determine the eligibility of the key for this operation. Supported algorithms for signing are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
- Ed25519 and Ed448
See CreateKey for details about key creation and algorithms.
When this method is called, data will be read from the InputFile or InputMessage.
The hash to be signed will be computed using the specified HashAlgorithm. The computed hash is stored in the HashValue property. The signed hash is stored in the HashSignature property.
To sign a hash without first computing it, set HashValue to a previously computed hash for the input data. Note: HashValue is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448.
The Progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.
After calling Sign, the public key must be sent to the recipient along with HashSignature and the original input data so the other party may perform signature verification.
The following properties are applicable when calling this method:
- Key (required)
- HashAlgorithm (applicable to ECDSA only)
- HashEdDSA (applicable to EdDSA only)
- HashValue (not applicable to PureEdDSA)
- UseHex
The following properties are populated after calling this method:
EdDSA Notes
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 control uses the PureEdDSA algorithm.
The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, HashValue is not applicable.
When using a HashEdDSA algorithm, the input is pre-hashed and supports a single pass over the data during the signing operation. To enable HashEdDSA, set HashEdDSA to True.
To specify context data when using Ed25519 or Ed448, set EdDSAContext.
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - PureEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - HashEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.HashEdDSA = true; //Use "ed25519ph"
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.HashEdDSA = true;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
VerifySignature Method (ECC Control)
Verifies the signature for the specified data.
Syntax
ecccontrol.VerifySignature
Remarks
VerifySignature will verify a hash signature and return True if successful or False otherwise.
Before calling this method, specify the input file by setting InputFile or InputMessage.
A public key and the hash signature are required to perform the signature verification. Specify the public key in SignerKey. Specify the hash signature in HashSignature.
When this method is called, the control will compute the hash for the specified file and populate HashValue. It will verify the signature using the specified SignerKey and HashSignature.
To verify the hash signature without first computing the hash, simply specify HashValue before calling this method. Note: HashValue is not applicable when the message was signed with a PureEdDSA algorithm such as Ed25519 or Ed448.
The Progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.
The following properties are applicable when calling this method:
- HashSignature (required)
- SignerKey (required)
- EdDSAContext (applicable to EdDSA only)
- HashAlgorithm (applicable to ECDSA only)
- HashEdDSA (applicable to EdDSA only)
- HashValue (not applicable to PureEdDSA)
- UseHex
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - PureEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - HashEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.HashEdDSA = true; //Use "ed25519ph"
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.HashEdDSA = true;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Error Event (ECC Control)
This event is fired for information about errors during data delivery.
Syntax
Sub ecccontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Progress Event (ECC Control)
Fired as progress is made.
Syntax
Sub ecccontrol_Progress(BytesProcessed As Long64, PercentProcessed As Integer)
Remarks
This event is fired automatically as data is processed by the control.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
Config Settings (ECC Control)
The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.ECC Config Settings
Note: This is not applicable when ComputeSecretKDF is set to 12 (ekdTLS).
This setting is required when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.
- SHA1
- SHA224
- SHA256 (default)
- SHA384
- SHA512
- RIPEMD160
This setting is required when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.
This setting is required when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.
This setting is optional when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.
This setting is optional when ComputeSecretKDF is set to ekdConcat. This setting is only applicable when calling ComputeSecret.
- 0 (Concatenated - default)
- 1 (ASN)
Note: This setting is only applicable when KeyAlgorithm is set to a NIST, Koblitz, or Brainpool curve.
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 control will automatically use Ed25519ctx.
If this value is specified before calling Sign, it must also be set prior to calling VerifySignature.
- 128
- 192
- 256 (default)
This is only applicable when calling ComputeSecret.
This setting is only applicable when calling Encrypt or Decrypt.
The value specified in this setting must a hex string.
If specified, this must be set before calling both Encrypt and Decrypt.
The value specified in this setting must a hex string.
If specified, this must be set before calling both Encrypt and Decrypt.
Note: This is not applicable when ComputeSecretKDF is set to 12 (ekdTLS).
When using keys with the algorithm Ed25519, Ed448, X25519, or X448, the control 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 control will perform calculations to verify that the public key is a point on the curve. The control 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 control will use the public and private keys as provided without any additional checks.
Base Config Settings
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (ECC Control)
ECC Errors
| 20103 | No Key specified. |
| 20105 | Cannot read or write file. |
| 20112 | OutputFile already exists and Overwrite is False. |
| 20121 | Invalid curve. |
| 20125 | HashSignature must be specified. |
| 20305 | Cannot write file. |
| 20306 | Cannot read file. |
| 20307 | Cannot create file. |
| 21402 | Specified ECC parameters are invalid. |
| 21403 | Missing hash value. |
| 21404 | Public key must be specified. |
| 21405 | Key must be specified. |
| 21406 | HashSignature must be specified. |
| 21407 | Invalid key size. |
| 21408 | Invalid TLS seed. TLSSeed must be 64 bytes long. |
| 21409 | Invalid TLS label. |
| 21410 | Unsupported key format. |
| 21411 | Unsupported curve. |