# ECC Control 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](#createkey-method-ecc-control) allows key creation using algorithms such as secp256r1, secp384r1, secp521r1, X25519, X448, Ed25519, Ed448, and more. - [ComputeSecret](#computesecret-method-ecc-control) computes a shared secret between two parties using a public and private key (ECDH). - [Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control) provides a way to digitally sign data and verify signatures (ECDSA and EdDSA). - [Encrypt](#encrypt-method-ecc-control) and [Decrypt](#decrypt-method-ecc-control) 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](#createkey-method-ecc-control) creates a new public and private key. When this method is called, Key is populated with the generated key. The [KeyPublicKey](#keypublickey-property-ecc-control) and [KeyPrivateKey](#keyprivatekey-property-ecc-control) 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: | KeyAlgorithm | Supported Operations | | --- | --- | | secp256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | Ed25519 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | Ed448 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | **NIST, Koblitz, and Brainpool Curve Notes** Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters. The public key consists of the following parameters: - [KeyRx](#keyrx-property-ecc-control) - [KeyRy](#keyry-property-ecc-control) The private key consists of one value: - [KeyK](#keyk-property-ecc-control) **Curve25519 and Curve448 Notes** Keys for use with *Curve25519* or *Curve448* are made up of a private key and public key field. [KeyXPk](#keyxpk-property-ecc-control) holds the public key. [KeyXSk](#keyxsk-property-ecc-control) holds the private key. **Create Key Example (secp256r1 - PEM)** ```csharp //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)** ```csharp //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)** ```csharp //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)** ```csharp //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](#recipientkeypublickey-property-ecc-control) and the private key specified by Key to compute a shared secret, or secret agreement. The [ComputeSecretKDF](#computesecretkdf-property-ecc-control) property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by [SharedSecret](#sharedsecret-property-ecc-control). The following properties are applicable when calling this method: - Key (required) - [RecipientKeyPublicKey](#recipientkeypublickey-property-ecc-control) (required) - [ComputeSecretKDF](#computesecretkdf-property-ecc-control) (optional) See [ComputeSecretKDF](#computesecretkdf-property-ecc-control) 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** ```csharp //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](#sign-method-ecc-control) 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](#keyalgorithm-property-ecc-control) 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](#createkey-method-ecc-control) for details about key creation and algorithms. When this method is called, data will be read from the [InputFile](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control). The hash to be signed will be computed using the specified [HashAlgorithm](#hashalgorithm-property-ecc-control). The computed hash is stored in the [HashValue](#hashvalue-property-ecc-control) property. The signed hash is stored in the [HashSignature](#hashsignature-property-ecc-control) property. To sign a hash without first computing it, set [HashValue](#hashvalue-property-ecc-control) to a previously computed hash for the input data. Note: [HashValue](#hashvalue-property-ecc-control) is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448. The [Progress](#progress-event-ecc-control) 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](#sign-method-ecc-control), the public key must be sent to the recipient along with [HashSignature](#hashsignature-property-ecc-control) 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](#hashalgorithm-property-ecc-control) (applicable to ECDSA only) - [HashEdDSA](#hasheddsa-property-ecc-control) (applicable to EdDSA only) - [HashValue](#hashvalue-property-ecc-control) (not applicable to PureEdDSA) - [UseHex](#usehex-property-ecc-control) The following properties are populated after calling this method: - [HashValue](#hashvalue-property-ecc-control) - [HashSignature](#hashsignature-property-ecc-control) When the [KeyAlgorithm](#keyalgorithm-property-ecc-control) is *Ed25519* or *Ed448*, the following additional parameters are applicable: - [HashEdDSA](#hasheddsa-property-ecc-control) - [EdDSAContext](#EdDSAContext) EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the [HashEdDSA](#hasheddsa-property-ecc-control) 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](#hashvalue-property-ecc-control) 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](#hasheddsa-property-ecc-control) to True. To specify context data when using *Ed25519* or *Ed448*, set [EdDSAContext](#EdDSAContext). **Sign And Verify Example (ECDSA)** ```csharp //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)** ```csharp //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)** ```csharp //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](#verifysignature-method-ecc-control) will verify a hash signature and return *True* if successful or *False* otherwise. Before calling this method, specify the input file by setting [InputFile](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control). 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](#hashsignature-property-ecc-control). When this method is called, the control will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ecc-control). It will verify the signature using the specified SignerKey and [HashSignature](#hashsignature-property-ecc-control). To verify the hash signature without first computing the hash, simply specify [HashValue](#hashvalue-property-ecc-control) before calling this method. Note: [HashValue](#hashvalue-property-ecc-control) is not applicable when the message was signed with a PureEdDSA algorithm such as *Ed25519* or *Ed448*. The [Progress](#progress-event-ecc-control) 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](#hashsignature-property-ecc-control) (required) - SignerKey (required) - [EdDSAContext](#EdDSAContext) (applicable to EdDSA only) - [HashAlgorithm](#hashalgorithm-property-ecc-control) (applicable to ECDSA only) - [HashEdDSA](#hasheddsa-property-ecc-control) (applicable to EdDSA only) - [HashValue](#hashvalue-property-ecc-control) (not applicable to PureEdDSA) - [UseHex](#usehex-property-ecc-control) **Sign And Verify Example (ECDSA)** ```csharp //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)** ```csharp //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)** ```csharp //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](#encrypt-method-ecc-control) 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](#keyalgorithm-property-ecc-control) 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](#createkey-method-ecc-control) 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](#usehex-property-ecc-control) to True. The following properties are applicable when calling this method: - [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) - [HMACAlgorithm](#hmacalgorithm-property-ecc-control) - [HMACOptionalInfo](#HMACOptionalInfo) - [HMACKeySize](#HMACKeySize) - [IV](#iv-property-ecc-control) - [KDF](#kdf-property-ecc-control) - [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-control) - [KDFOptionalInfo](#KDFOptionalInfo) - [UseHex](#usehex-property-ecc-control) **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](#inputfile-property-ecc-control) - [InputMessage](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - [OutputMessage](#outputmessage-property-ecc-control): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt Example** ```csharp //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)** ```csharp //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)** ```csharp //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)** ```csharp //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](#decrypt-method-ecc-control) 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](#keyalgorithm-property-ecc-control) 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](#createkey-method-ecc-control) 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](#usehex-property-ecc-control) to True. The following properties are applicable when calling this method: - [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) - [HMACAlgorithm](#hmacalgorithm-property-ecc-control) - [HMACOptionalInfo](#HMACOptionalInfo) - [HMACKeySize](#HMACKeySize) - [IV](#iv-property-ecc-control) - [KDF](#kdf-property-ecc-control) - [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-control) - [KDFOptionalInfo](#KDFOptionalInfo) - [UseHex](#usehex-property-ecc-control) **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](#inputfile-property-ecc-control) - [InputMessage](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - [OutputMessage](#outputmessage-property-ecc-control): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt Example** ```csharp //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)** ```csharp //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)** ```csharp //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)** ```csharp //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](#certeffectivedate-property-ecc-control) | The date on which this certificate becomes valid. | | [CertEncoded](#certencoded-property-ecc-control) | The certificate (PEM/Base64 encoded). | | [CertExpirationDate](#certexpirationdate-property-ecc-control) | The date on which the certificate expires. | | [CertExtendedKeyUsage](#certextendedkeyusage-property-ecc-control) | A comma-delimited list of extended key usage identifiers. | | [CertFingerprint](#certfingerprint-property-ecc-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [CertFingerprintSHA1](#certfingerprintsha1-property-ecc-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [CertFingerprintSHA256](#certfingerprintsha256-property-ecc-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [CertIssuer](#certissuer-property-ecc-control) | The issuer of the certificate. | | [CertPrivateKey](#certprivatekey-property-ecc-control) | The private key of the certificate (if available). | | [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ecc-control) | Whether a PrivateKey is available for the selected certificate. | | [CertPrivateKeyContainer](#certprivatekeycontainer-property-ecc-control) | The name of the PrivateKey container for the certificate (if available). | | [CertPublicKey](#certpublickey-property-ecc-control) | The public key of the certificate. | | [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-ecc-control) | The textual description of the certificate's public key algorithm. | | [CertPublicKeyLength](#certpublickeylength-property-ecc-control) | The length of the certificate's public key (in bits). | | [CertSerialNumber](#certserialnumber-property-ecc-control) | The serial number of the certificate encoded as a string. | | [CertSignatureAlgorithm](#certsignaturealgorithm-property-ecc-control) | The text description of the certificate's signature algorithm. | | [CertStore](#certstore-property-ecc-control) | The name of the certificate store for the client certificate. | | [CertStorePassword](#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. | | [CertStoreType](#certstoretype-property-ecc-control) | The type of certificate store for this certificate. | | [CertSubject](#certsubject-property-ecc-control) | The subject of the certificate used for client authentication. | | [CertSubjectAltNames](#certsubjectaltnames-property-ecc-control) | Comma-separated lists of alternative subject names for the certificate. | | [CertThumbprintMD5](#certthumbprintmd5-property-ecc-control) | The MD5 hash of the certificate. | | [CertThumbprintSHA1](#certthumbprintsha1-property-ecc-control) | The SHA-1 hash of the certificate. | | [CertThumbprintSHA256](#certthumbprintsha256-property-ecc-control) | The SHA-256 hash of the certificate. | | [CertUsage](#certusage-property-ecc-control) | The text description of UsageFlags . | | [CertUsageFlags](#certusageflags-property-ecc-control) | The flags that show intended use for the certificate. | | [CertVersion](#certversion-property-ecc-control) | The certificate's version number. | | [ComputeSecretKDF](#computesecretkdf-property-ecc-control) | The key derivation function. | | [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) | The encryption algorithm to use. | | [HashAlgorithm](#hashalgorithm-property-ecc-control) | The hash algorithm used for hash computation. | | [HashEdDSA](#hasheddsa-property-ecc-control) | Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key. | | [HashSignature](#hashsignature-property-ecc-control) | The hash signature. | | [HashValue](#hashvalue-property-ecc-control) | The hash value of the data. | | [HMACAlgorithm](#hmacalgorithm-property-ecc-control) | The HMAC algorithm to use during encryption. | | [InputFile](#inputfile-property-ecc-control) | The file to process. | | [InputMessage](#inputmessage-property-ecc-control) | The message to process. | | [IV](#iv-property-ecc-control) | The initialization vector (IV) used when encrypting. | | [KDF](#kdf-property-ecc-control) | The key derivation function used during encryption and decryption. | | [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-control) | The KDF hash algorithm to use when encrypting and decrypting. | | [KeyAlgorithm](#keyalgorithm-property-ecc-control) | This property holds the algorithm associated with the key. | | [KeyK](#keyk-property-ecc-control) | Represents the private key (K) parameter. | | [KeyPrivateKey](#keyprivatekey-property-ecc-control) | This property is a PEM formatted private key. | | [KeyPublicKey](#keypublickey-property-ecc-control) | This property is a PEM formatted public key. | | [KeyRx](#keyrx-property-ecc-control) | Represents the public key's Rx parameter. | | [KeyRy](#keyry-property-ecc-control) | Represents the public key's Ry parameter. | | [KeyXPk](#keyxpk-property-ecc-control) | Holds the public key data. | | [KeyXSk](#keyxsk-property-ecc-control) | Holds the private key data. | | [OutputFile](#outputfile-property-ecc-control) | The output file when encrypting or decrypting. | | [OutputMessage](#outputmessage-property-ecc-control) | The output message when encrypting or decrypting. | | [Overwrite](#overwrite-property-ecc-control) | Indicates whether or not the control should overwrite files. | | [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-ecc-control) | The date on which this certificate becomes valid. | | [RecipientCertEncoded](#recipientcertencoded-property-ecc-control) | The certificate (PEM/Base64 encoded). | | [RecipientCertExpirationDate](#recipientcertexpirationdate-property-ecc-control) | The date on which the certificate expires. | | [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-ecc-control) | A comma-delimited list of extended key usage identifiers. | | [RecipientCertFingerprint](#recipientcertfingerprint-property-ecc-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-ecc-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-ecc-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [RecipientCertIssuer](#recipientcertissuer-property-ecc-control) | The issuer of the certificate. | | [RecipientCertPrivateKey](#recipientcertprivatekey-property-ecc-control) | The private key of the certificate (if available). | | [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ecc-control) | Whether a PrivateKey is available for the selected certificate. | | [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-ecc-control) | The name of the PrivateKey container for the certificate (if available). | | [RecipientCertPublicKey](#recipientcertpublickey-property-ecc-control) | The public key of the certificate. | | [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-ecc-control) | The textual description of the certificate's public key algorithm. | | [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-ecc-control) | The length of the certificate's public key (in bits). | | [RecipientCertSerialNumber](#recipientcertserialnumber-property-ecc-control) | The serial number of the certificate encoded as a string. | | [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-ecc-control) | The text description of the certificate's signature algorithm. | | [RecipientCertStore](#recipientcertstore-property-ecc-control) | The name of the certificate store for the client certificate. | | [RecipientCertStorePassword](#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. | | [RecipientCertStoreType](#recipientcertstoretype-property-ecc-control) | The type of certificate store for this certificate. | | [RecipientCertSubject](#recipientcertsubject-property-ecc-control) | The subject of the certificate used for client authentication. | | [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-ecc-control) | Comma-separated lists of alternative subject names for the certificate. | | [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-ecc-control) | The MD5 hash of the certificate. | | [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-ecc-control) | The SHA-1 hash of the certificate. | | [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-ecc-control) | The SHA-256 hash of the certificate. | | [RecipientCertUsage](#recipientcertusage-property-ecc-control) | The text description of UsageFlags . | | [RecipientCertUsageFlags](#recipientcertusageflags-property-ecc-control) | The flags that show intended use for the certificate. | | [RecipientCertVersion](#recipientcertversion-property-ecc-control) | The certificate's version number. | | [RecipientKeyAlgorithm](#recipientkeyalgorithm-property-ecc-control) | This property holds the algorithm associated with the key. | | [RecipientKeyPublicKey](#recipientkeypublickey-property-ecc-control) | This property is a PEM formatted public key. | | [RecipientKeyRx](#recipientkeyrx-property-ecc-control) | Represents the public key's Rx parameter. | | [RecipientKeyRy](#recipientkeyry-property-ecc-control) | Represents the public key's Ry parameter. | | [RecipientKeyXPk](#recipientkeyxpk-property-ecc-control) | Holds the public key data. | | [SharedSecret](#sharedsecret-property-ecc-control) | The computed shared secret. | | [SignerCertEffectiveDate](#signercerteffectivedate-property-ecc-control) | The date on which this certificate becomes valid. | | [SignerCertEncoded](#signercertencoded-property-ecc-control) | The certificate (PEM/Base64 encoded). | | [SignerCertExpirationDate](#signercertexpirationdate-property-ecc-control) | The date on which the certificate expires. | | [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-ecc-control) | A comma-delimited list of extended key usage identifiers. | | [SignerCertFingerprint](#signercertfingerprint-property-ecc-control) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-ecc-control) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-ecc-control) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SignerCertIssuer](#signercertissuer-property-ecc-control) | The issuer of the certificate. | | [SignerCertPrivateKey](#signercertprivatekey-property-ecc-control) | The private key of the certificate (if available). | | [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ecc-control) | Whether a PrivateKey is available for the selected certificate. | | [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-ecc-control) | The name of the PrivateKey container for the certificate (if available). | | [SignerCertPublicKey](#signercertpublickey-property-ecc-control) | The public key of the certificate. | | [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-ecc-control) | The textual description of the certificate's public key algorithm. | | [SignerCertPublicKeyLength](#signercertpublickeylength-property-ecc-control) | The length of the certificate's public key (in bits). | | [SignerCertSerialNumber](#signercertserialnumber-property-ecc-control) | The serial number of the certificate encoded as a string. | | [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-ecc-control) | The text description of the certificate's signature algorithm. | | [SignerCertStore](#signercertstore-property-ecc-control) | The name of the certificate store for the client certificate. | | [SignerCertStorePassword](#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. | | [SignerCertStoreType](#signercertstoretype-property-ecc-control) | The type of certificate store for this certificate. | | [SignerCertSubject](#signercertsubject-property-ecc-control) | The subject of the certificate used for client authentication. | | [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-ecc-control) | Comma-separated lists of alternative subject names for the certificate. | | [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-ecc-control) | The MD5 hash of the certificate. | | [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-ecc-control) | The SHA-1 hash of the certificate. | | [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-ecc-control) | The SHA-256 hash of the certificate. | | [SignerCertUsage](#signercertusage-property-ecc-control) | The text description of UsageFlags . | | [SignerCertUsageFlags](#signercertusageflags-property-ecc-control) | The flags that show intended use for the certificate. | | [SignerCertVersion](#signercertversion-property-ecc-control) | The certificate's version number. | | [SignerKeyAlgorithm](#signerkeyalgorithm-property-ecc-control) | This property holds the algorithm associated with the key. | | [SignerKeyPublicKey](#signerkeypublickey-property-ecc-control) | This property is a PEM formatted public key. | | [SignerKeyRx](#signerkeyrx-property-ecc-control) | Represents the public key's Rx parameter. | | [SignerKeyRy](#signerkeyry-property-ecc-control) | Represents the public key's Ry parameter. | | [SignerKeyXPk](#signerkeyxpk-property-ecc-control) | Holds the public key data. | | [UseHex](#usehex-property-ecc-control) | 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](#computesecret-method-ecc-control) | Computes a shared secret. | | [Config](#config-method-ecc-control) | Sets or retrieves a configuration setting. | | [CreateKey](#createkey-method-ecc-control) | Creates a new key. | | [Decrypt](#decrypt-method-ecc-control) | Decrypted the specified data. | | [Encrypt](#encrypt-method-ecc-control) | Encrypts the specified data. | | [Reset](#reset-method-ecc-control) | Resets the control. | | [Sign](#sign-method-ecc-control) | Creates a hash signature using ECDSA or EdDSA. | | [VerifySignature](#verifysignature-method-ecc-control) | 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](#error-event-ecc-control) | Fired when information is available about errors during data delivery. | | [Progress](#progress-event-ecc-control) | 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](#AppendSecret) | An optional string to append to the secret agreement. | | [CNGECDHKey](#CNGECDHKey) | The CNG ECDH key. | | [CNGECDSAKey](#CNGECDSAKey) | The CNG ECDSA key. | | [ConcatAlgorithmId](#ConcatAlgorithmId) | The AlgorithmId subfield of the OtherInfo field. | | [ConcatHashAlgorithm](#ConcatHashAlgorithm) | The hash algorithm to use when ComputeSecretKDF is Concat. | | [ConcatPartyUInfo](#ConcatPartyUInfo) | The PartyUInfo subfield of the OtherInfo field. | | [ConcatPartyVInfo](#ConcatPartyVInfo) | The PartyVInfo subfield of the OtherInfo field. | | [ConcatSuppPrivInfo](#ConcatSuppPrivInfo) | The SuppPrivInfo subfield of the OtherInfo field. | | [ConcatSuppPubInfo](#ConcatSuppPubInfo) | The SuppPubInfo subfield of the OtherInfo field. | | [ECDSASignatureFormat](#ECDSASignatureFormat) | The format of the HashSignature when using ECDSA keys. | | [EdDSAContext](#EdDSAContext) | A hex encoded string holding the bytes of the context when signing or verifying with Ed25519ctx. | | [EncryptionKeySize](#EncryptionKeySize) | The encryption key size. | | [HMACKey](#HMACKey) | A key to use when generating a Hash-based Message Authentication Code (HMAC). | | [HMACKeySize](#HMACKeySize) | The HMAC key size to be used during encryption. | | [HMACOptionalInfo](#HMACOptionalInfo) | Optional data to be used during encryption and decryption during the HMAC step. | | [KDFOptionalInfo](#KDFOptionalInfo) | Optional data to be used during encryption and decryption during the key derivation step. | | [PrependSecret](#PrependSecret) | An optional string to prepend to the secret agreement. | | [RawY](#RawY) | The raw Y coordinate value. | | [StrictKeyValidation](#StrictKeyValidation) | Whether to validate provided public keys based on private keys. | | [TLSLabel](#TLSLabel) | The TLS PRF label. | | [TLSSeed](#TLSSeed) | The TLS PRF Seed. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # CertEffectiveDate Property ([ECC](#ecc-control) Control) The date on which this certificate becomes valid. ## Syntax ```text ecccontrol.CertEffectiveDate ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # CertEncoded Property ([ECC](#ecc-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text ecccontrol.CertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-ecc-control) and [CertSubject](#certsubject-property-ecc-control) properties also may be used to specify a certificate. When [CertEncoded](#certencoded-property-ecc-control) is set, a search is initiated in the current [CertStore](#certstore-property-ecc-control) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-ecc-control) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-ecc-control) 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 # CertExpirationDate Property ([ECC](#ecc-control) Control) The date on which the certificate expires. ## Syntax ```text ecccontrol.CertExpirationDate ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # CertExtendedKeyUsage Property ([ECC](#ecc-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text ecccontrol.CertExtendedKeyUsage ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text ecccontrol.CertFingerprint ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text ecccontrol.CertFingerprintSHA1 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text ecccontrol.CertFingerprintSHA256 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The issuer of the certificate. ## Syntax ```text ecccontrol.CertIssuer ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The private key of the certificate (if available). ## Syntax ```text ecccontrol.CertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [CertPrivateKey](#certprivatekey-property-ecc-control) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-ecc-control) returns an empty string. This property is read-only. ## Data Type String # CertPrivateKeyAvailable Property ([ECC](#ecc-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text ecccontrol.CertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [CertPrivateKey](#certprivatekey-property-ecc-control) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ecc-control) 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](#ecc-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text ecccontrol.CertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [CertPrivateKey](#certprivatekey-property-ecc-control) 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](#ecc-control) Control) The public key of the certificate. ## Syntax ```text ecccontrol.CertPublicKey ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text ecccontrol.CertPublicKeyAlgorithm ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text ecccontrol.CertPublicKeyLength ``` ## Default Value 0 ## Remarks 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](#ecc-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text ecccontrol.CertSerialNumber ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text ecccontrol.CertSignatureAlgorithm ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text ecccontrol.CertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [CertStoreType](#certstoretype-property-ecc-control) property denotes the type of the certificate store specified by [CertStore](#certstore-property-ecc-control). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-ecc-control). [CertStore](#certstore-property-ecc-control) is used in conjunction with the [CertSubject](#certsubject-property-ecc-control) property to specify client certificates. If [CertStore](#certstore-property-ecc-control) has a value, and [CertSubject](#certsubject-property-ecc-control) or [CertEncoded](#certencoded-property-ecc-control) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-ecc-control) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). 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](#ecc-control) 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 ```text 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](#ecc-control) Control) The type of certificate store for this certificate. ## Syntax ```text ecccontrol.CertStoreType[=integer] ``` ## Possible Values ```text 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 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [CertStoreType](#certstoretype-property-ecc-control), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-ecc-control), and the PIN as the [CertStorePassword](#certstorepassword-property-ecc-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [CertStore](#certstore-property-ecc-control) and set [CertStorePassword](#certstorepassword-property-ecc-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # CertSubject Property ([ECC](#ecc-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text ecccontrol.CertSubject[=string] ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname 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 # CertSubjectAltNames Property ([ECC](#ecc-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text ecccontrol.CertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # CertThumbprintMD5 Property ([ECC](#ecc-control) Control) The MD5 hash of the certificate. ## Syntax ```text ecccontrol.CertThumbprintMD5 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text ecccontrol.CertThumbprintSHA1 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text ecccontrol.CertThumbprintSHA256 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The text description of UsageFlags . ## Syntax ```text ecccontrol.CertUsage ``` ## Default Value "" ## Remarks The text description of [CertUsageFlags](#certusageflags-property-ecc-control). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # CertUsageFlags Property ([ECC](#ecc-control) Control) The flags that show intended use for the certificate. ## Syntax ```text ecccontrol.CertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-ecc-control) 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](#certusage-property-ecc-control) property for a text representation of [CertUsageFlags](#certusageflags-property-ecc-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # CertVersion Property ([ECC](#ecc-control) Control) The certificate's version number. ## Syntax ```text ecccontrol.CertVersion ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ComputeSecretKDF Property ([ECC](#ecc-control) Control) The key derivation function. ## Syntax ```text ecccontrol.ComputeSecretKDF[=integer] ``` ## Possible Values ```text 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), ekdRaw(99) ``` ## Default Value 1 ## Remarks This property specifies the key derivation function (KDF) and algorithm to use when calling [ComputeSecret](#computesecret-method-ecc-control). 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 | | 99 (ekdRaw) | Raw | ### HMAC Notes If an HMAC algorithm is selected, [HMACKey](#HMACKey) may optionally be set to specify the key. ### TLS Notes When set to TLS, [TLSSeed](#TLSSeed) and [TLSLabel](#TLSLabel) are required. In addition, [PrependSecret](#PrependSecret) and [AppendSecret](#AppendSecret) are not applicable. ### Concat Notes If Concat is selected, the following configuration settings are applicable: - [ConcatAlgorithmId](#ConcatAlgorithmId) (required) - [ConcatPartyUInfo](#ConcatPartyUInfo) (required) - [ConcatPartyVInfo](#ConcatPartyVInfo) (required) - [ConcatSuppPubInfo](#ConcatSuppPubInfo) - [ConcatSuppPrivInfo](#ConcatSuppPrivInfo) - [ConcatHashAlgorithm](#ConcatHashAlgorithm) ### Raw Mode If Raw is selected, no secure key derivation function is applied to the value returned in [SharedSecret](#sharedsecret-property-ecc-control). This mode is intended for advanced use cases where access to the raw coordinates of the shared secret is required. In Raw mode: - The X-coordinate is returned through the [SharedSecret](#sharedsecret-property-ecc-control) property. - The corresponding Y-coordinate is made available via the [RawY](#RawY) configuration setting. This option should be used with caution, as bypassing key derivation may introduce security risks if not handled properly. ## Data Type Integer # EncryptionAlgorithm Property ([ECC](#ecc-control) Control) The encryption algorithm to use. ## Syntax ```text ecccontrol.EncryptionAlgorithm[=integer] ``` ## Possible Values ```text iesAES(0), iesTripleDES(1), iesXOR(2) ``` ## Default Value 0 ## Remarks This setting specifies the encryption algorithm to use when [Encrypt](#encrypt-method-ecc-control) is called. This must also be set before calling [Decrypt](#decrypt-method-ecc-control) 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](#EncryptionKeySize). ## Data Type Integer # HashAlgorithm Property ([ECC](#ecc-control) Control) The hash algorithm used for hash computation. ## Syntax ```text ecccontrol.HashAlgorithm[=integer] ``` ## Possible Values ```text 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](#sign-method-ecc-control) or [VerifySignature](#verifysignature-method-ecc-control) and [KeyAlgorithm](#keyalgorithm-property-ecc-control) 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](#keyalgorithm-property-ecc-control) 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](#ecc-control) Control) Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key. ## Syntax ```text 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](#sign-method-ecc-control) and [KeyAlgorithm](#keyalgorithm-property-ecc-control) is set to *Ed25519* or *Ed448*. If this property is set before calling [Sign](#sign-method-ecc-control), it must be set before calling [VerifySignature](#verifysignature-method-ecc-control). ## Data Type Boolean # HashSignature Property ([ECC](#ecc-control) Control) The hash signature. ## Syntax ```text ecccontrol.HashSignature[=string] ``` ## Default Value "" ## Remarks This property holds the computed hash signature. This is populated after calling [Sign](#sign-method-ecc-control). This must be set before calling [VerifySignature](#verifysignature-method-ecc-control). 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](#ecc-control) Control) The hash value of the data. ## Syntax ```text ecccontrol.HashValue[=string] ``` ## Default Value "" ## Remarks This property holds the computed hash value for the specified data. This is populated when calling [Sign](#sign-method-ecc-control) or [VerifySignature](#verifysignature-method-ecc-control) when an input file is specified by setting [InputFile](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control). Pre-existing hash values may be set to this property before calling [Sign](#sign-method-ecc-control) or [VerifySignature](#verifysignature-method-ecc-control). 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](#keyalgorithm-property-ecc-control) is *Ed25519* or *Ed448* and [HashEdDSA](#hasheddsa-property-ecc-control) 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](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control), the hash will be recomputed when calling [Sign](#sign-method-ecc-control) or [VerifySignature](#verifysignature-method-ecc-control). If the HashValue property is set, the control will only sign the hash or verify the hash signature. Setting [InputFile](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control) 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](#ecc-control) Control) The HMAC algorithm to use during encryption. ## Syntax ```text ecccontrol.HMACAlgorithm[=integer] ``` ## Possible Values ```text 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](#encrypt-method-ecc-control) and [Decrypt](#decrypt-method-ecc-control) 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](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control). ## Data Type Integer # InputFile Property ([ECC](#ecc-control) Control) The file to process. ## Syntax ```text 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](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - [OutputMessage](#outputmessage-property-ecc-control): The output data is written to this property if no other destination is specified. ## Data Type String # InputMessage Property ([ECC](#ecc-control) Control) The message to process. ## Syntax ```text 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](#inputfile-property-ecc-control) - InputMessage When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - [OutputMessage](#outputmessage-property-ecc-control): 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](#ecc-control) Control) The initialization vector (IV) used when encrypting. ## Syntax ```text ecccontrol.IV[=string] ``` ## Default Value "" ## Remarks This property optionally specifies an IV to be used when calling [Encrypt](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control). If specified, the IV is used by [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) 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](#encryptionalgorithm-property-ecc-control) | IV Length (in bytes) | | AES | 16 | | 3DES | 8 | This setting is not applicable when [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) 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](#ecc-control) Control) The key derivation function used during encryption and decryption. ## Syntax ```text ecccontrol.KDF[=string] ``` ## Default Value "KDF2" ## Remarks This property specifies the key derivation function (KDF) to use when encrypting and decrypting. Possible values are: - "KDF1" - "KDF2" (default) The [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-control) specifies the hash algorithm used in conjunction with the specified KDF. This property is only applicable when calling [Encrypt](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control). ## Data Type String # KDFHashAlgorithm Property ([ECC](#ecc-control) Control) The KDF hash algorithm to use when encrypting and decrypting. ## Syntax ```text ecccontrol.KDFHashAlgorithm[=integer] ``` ## Possible Values ```text 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](#kdf-property-ecc-control). Possible values are: - 0 (iesSHA1) - 1 (iesSHA224) - 2 (iesSHA256) - 3 (iesSHA384) - 4 (iesSHA512) This property is only applicable when calling [Encrypt](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control). ## Data Type Integer # KeyAlgorithm Property ([ECC](#ecc-control) Control) This property holds the algorithm associated with the key. ## Syntax ```text ecccontrol.KeyAlgorithm[=integer] ``` ## Possible Values ```text 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](#keyprivatekey-property-ecc-control) and [KeyPublicKey](#keypublickey-property-ecc-control), the [KeyAlgorithm](#keyalgorithm-property-ecc-control) property will be automatically updated with the key algorithm. When assigning a key using the raw key parameters ([KeyK](#keyk-property-ecc-control), [KeyRx](#keyrx-property-ecc-control), and [KeyRy](#keyry-property-ecc-control) for NIST or [KeyXPk](#keyxpk-property-ecc-control), and [KeyXSk](#keyxsk-property-ecc-control) for Curve25519/Curve448), the [KeyAlgorithm](#keyalgorithm-property-ecc-control) 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](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | Ed25519 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | Ed448 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | ## Data Type Integer # KeyK Property ([ECC](#ecc-control) Control) Represents the private key (K) parameter. ## Syntax ```text 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](#ecc-control) Control) This property is a PEM formatted private key. ## Syntax ```text 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](#ecc-control) Control) This property is a PEM formatted public key. ## Syntax ```text 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](#ecc-control) Control) Represents the public key's Rx parameter. ## Syntax ```text 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](#ecc-control) Control) Represents the public key's Ry parameter. ## Syntax ```text 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](#ecc-control) Control) Holds the public key data. ## Syntax ```text 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](#ecc-control) Control) Holds the private key data. ## Syntax ```text 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](#ecc-control) Control) The output file when encrypting or decrypting. ## Syntax ```text ecccontrol.OutputFile[=string] ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written when [Encrypt](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control) is called. This may be set to an absolute or relative path. This property is only applicable to [Encrypt](#encrypt-method-ecc-control) and [Decrypt](#decrypt-method-ecc-control). **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](#inputfile-property-ecc-control) - [InputMessage](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - OutputFile - [OutputMessage](#outputmessage-property-ecc-control): The output data is written to this property if no other destination is specified. ## Data Type String # OutputMessage Property ([ECC](#ecc-control) Control) The output message when encrypting or decrypting. ## Syntax ```text ecccontrol.OutputMessage ``` ## Default Value "" ## Remarks This property will be populated with the output after calling [Encrypt](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control) if [OutputFile](#outputfile-property-ecc-control) is not set. This property is only applicable to [Encrypt](#encrypt-method-ecc-control) and [Decrypt](#decrypt-method-ecc-control). **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](#inputfile-property-ecc-control) - [InputMessage](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - 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](#ecc-control) Control) Indicates whether or not the control should overwrite files. ## Syntax ```text ecccontrol.Overwrite[=boolean] ``` ## Default Value False ## Remarks This property indicates whether or not the control will overwrite [OutputFile](#outputfile-property-ecc-control). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-ecc-control) exists before an operation. The default value is False. ## Data Type Boolean # RecipientCertEffectiveDate Property ([ECC](#ecc-control) Control) The date on which this certificate becomes valid. ## Syntax ```text ecccontrol.RecipientCertEffectiveDate ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # RecipientCertEncoded Property ([ECC](#ecc-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text ecccontrol.RecipientCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [RecipientCertStore](#recipientcertstore-property-ecc-control) and [RecipientCertSubject](#recipientcertsubject-property-ecc-control) properties also may be used to specify a certificate. When [RecipientCertEncoded](#recipientcertencoded-property-ecc-control) is set, a search is initiated in the current [RecipientCertStore](#recipientcertstore-property-ecc-control) for the private key of the certificate. If the key is found, [RecipientCertSubject](#recipientcertsubject-property-ecc-control) is updated to reflect the full subject of the selected certificate; otherwise, [RecipientCertSubject](#recipientcertsubject-property-ecc-control) 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 # RecipientCertExpirationDate Property ([ECC](#ecc-control) Control) The date on which the certificate expires. ## Syntax ```text ecccontrol.RecipientCertExpirationDate ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # RecipientCertExtendedKeyUsage Property ([ECC](#ecc-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text ecccontrol.RecipientCertExtendedKeyUsage ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text ecccontrol.RecipientCertFingerprint ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text ecccontrol.RecipientCertFingerprintSHA1 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text ecccontrol.RecipientCertFingerprintSHA256 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The issuer of the certificate. ## Syntax ```text ecccontrol.RecipientCertIssuer ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The private key of the certificate (if available). ## Syntax ```text ecccontrol.RecipientCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [RecipientCertPrivateKey](#recipientcertprivatekey-property-ecc-control) may be available but not exportable. In this case, [RecipientCertPrivateKey](#recipientcertprivatekey-property-ecc-control) returns an empty string. This property is read-only. ## Data Type String # RecipientCertPrivateKeyAvailable Property ([ECC](#ecc-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text ecccontrol.RecipientCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [RecipientCertPrivateKey](#recipientcertprivatekey-property-ecc-control) is available for the selected certificate. If [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ecc-control) 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](#ecc-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text ecccontrol.RecipientCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [RecipientCertPrivateKey](#recipientcertprivatekey-property-ecc-control) 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](#ecc-control) Control) The public key of the certificate. ## Syntax ```text ecccontrol.RecipientCertPublicKey ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text ecccontrol.RecipientCertPublicKeyAlgorithm ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text ecccontrol.RecipientCertPublicKeyLength ``` ## Default Value 0 ## Remarks 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](#ecc-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text ecccontrol.RecipientCertSerialNumber ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text ecccontrol.RecipientCertSignatureAlgorithm ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text ecccontrol.RecipientCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [RecipientCertStoreType](#recipientcertstoretype-property-ecc-control) property denotes the type of the certificate store specified by [RecipientCertStore](#recipientcertstore-property-ecc-control). If the store is password-protected, specify the password in [RecipientCertStorePassword](#recipientcertstorepassword-property-ecc-control). [RecipientCertStore](#recipientcertstore-property-ecc-control) is used in conjunction with the [RecipientCertSubject](#recipientcertsubject-property-ecc-control) property to specify client certificates. If [RecipientCertStore](#recipientcertstore-property-ecc-control) has a value, and [RecipientCertSubject](#recipientcertsubject-property-ecc-control) or [RecipientCertEncoded](#recipientcertencoded-property-ecc-control) is set, a search for a certificate is initiated. Please see the [RecipientCertSubject](#recipientcertsubject-property-ecc-control) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). 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](#ecc-control) 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 ```text 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](#ecc-control) Control) The type of certificate store for this certificate. ## Syntax ```text ecccontrol.RecipientCertStoreType[=integer] ``` ## Possible Values ```text 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 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [RecipientCertStoreType](#recipientcertstoretype-property-ecc-control), the full path of the PKCS#11 DLL as the [RecipientCertStore](#recipientcertstore-property-ecc-control), and the PIN as the [RecipientCertStorePassword](#recipientcertstorepassword-property-ecc-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [RecipientCertStore](#recipientcertstore-property-ecc-control) and set [RecipientCertStorePassword](#recipientcertstorepassword-property-ecc-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # RecipientCertSubject Property ([ECC](#ecc-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text ecccontrol.RecipientCertSubject[=string] ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname 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 # RecipientCertSubjectAltNames Property ([ECC](#ecc-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text ecccontrol.RecipientCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # RecipientCertThumbprintMD5 Property ([ECC](#ecc-control) Control) The MD5 hash of the certificate. ## Syntax ```text ecccontrol.RecipientCertThumbprintMD5 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text ecccontrol.RecipientCertThumbprintSHA1 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text ecccontrol.RecipientCertThumbprintSHA256 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The text description of UsageFlags . ## Syntax ```text ecccontrol.RecipientCertUsage ``` ## Default Value "" ## Remarks The text description of [RecipientCertUsageFlags](#recipientcertusageflags-property-ecc-control). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # RecipientCertUsageFlags Property ([ECC](#ecc-control) Control) The flags that show intended use for the certificate. ## Syntax ```text ecccontrol.RecipientCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [RecipientCertUsageFlags](#recipientcertusageflags-property-ecc-control) 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](#recipientcertusage-property-ecc-control) property for a text representation of [RecipientCertUsageFlags](#recipientcertusageflags-property-ecc-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # RecipientCertVersion Property ([ECC](#ecc-control) Control) The certificate's version number. ## Syntax ```text ecccontrol.RecipientCertVersion ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # RecipientKeyAlgorithm Property ([ECC](#ecc-control) Control) This property holds the algorithm associated with the key. ## Syntax ```text ecccontrol.RecipientKeyAlgorithm[=integer] ``` ## Possible Values ```text 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](#ECC_p_RecipientKeyPrivateKey) and [RecipientKeyPublicKey](#recipientkeypublickey-property-ecc-control), the [RecipientKeyAlgorithm](#recipientkeyalgorithm-property-ecc-control) property will be automatically updated with the key algorithm. When assigning a key using the raw key parameters ([RecipientKeyK](#ECC_p_RecipientKeyK), [RecipientKeyRx](#recipientkeyrx-property-ecc-control), and [RecipientKeyRy](#recipientkeyry-property-ecc-control) for NIST or [RecipientKeyXPk](#recipientkeyxpk-property-ecc-control), and [RecipientKeyXSk](#ECC_p_RecipientKeyXSk) for Curve25519/Curve448), the [RecipientKeyAlgorithm](#recipientkeyalgorithm-property-ecc-control) 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](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | Ed25519 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | Ed448 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | ## Data Type Integer # RecipientKeyPublicKey Property ([ECC](#ecc-control) Control) This property is a PEM formatted public key. ## Syntax ```text 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](#ecc-control) Control) Represents the public key's Rx parameter. ## Syntax ```text 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](#ecc-control) Control) Represents the public key's Ry parameter. ## Syntax ```text 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](#ecc-control) Control) Holds the public key data. ## Syntax ```text 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](#ecc-control) Control) The computed shared secret. ## Syntax ```text ecccontrol.SharedSecret ``` ## Default Value "" ## Remarks This property holds the shared secret computed by [ComputeSecret](#computesecret-method-ecc-control). 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](#ecc-control) Control) The date on which this certificate becomes valid. ## Syntax ```text ecccontrol.SignerCertEffectiveDate ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # SignerCertEncoded Property ([ECC](#ecc-control) Control) The certificate (PEM/Base64 encoded). ## Syntax ```text ecccontrol.SignerCertEncoded[=string] ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-ecc-control) and [SignerCertSubject](#signercertsubject-property-ecc-control) properties also may be used to specify a certificate. When [SignerCertEncoded](#signercertencoded-property-ecc-control) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-ecc-control) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-ecc-control) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-ecc-control) 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 # SignerCertExpirationDate Property ([ECC](#ecc-control) Control) The date on which the certificate expires. ## Syntax ```text ecccontrol.SignerCertExpirationDate ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # SignerCertExtendedKeyUsage Property ([ECC](#ecc-control) Control) A comma-delimited list of extended key usage identifiers. ## Syntax ```text ecccontrol.SignerCertExtendedKeyUsage ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text ecccontrol.SignerCertFingerprint ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text ecccontrol.SignerCertFingerprintSHA1 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text ecccontrol.SignerCertFingerprintSHA256 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The issuer of the certificate. ## Syntax ```text ecccontrol.SignerCertIssuer ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The private key of the certificate (if available). ## Syntax ```text ecccontrol.SignerCertPrivateKey ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-ecc-control) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-ecc-control) returns an empty string. This property is read-only. ## Data Type String # SignerCertPrivateKeyAvailable Property ([ECC](#ecc-control) Control) Whether a PrivateKey is available for the selected certificate. ## Syntax ```text ecccontrol.SignerCertPrivateKeyAvailable ``` ## Default Value False ## Remarks Whether a [SignerCertPrivateKey](#signercertprivatekey-property-ecc-control) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ecc-control) 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](#ecc-control) Control) The name of the PrivateKey container for the certificate (if available). ## Syntax ```text ecccontrol.SignerCertPrivateKeyContainer ``` ## Default Value "" ## Remarks The name of the [SignerCertPrivateKey](#signercertprivatekey-property-ecc-control) 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](#ecc-control) Control) The public key of the certificate. ## Syntax ```text ecccontrol.SignerCertPublicKey ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The textual description of the certificate's public key algorithm. ## Syntax ```text ecccontrol.SignerCertPublicKeyAlgorithm ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The length of the certificate's public key (in bits). ## Syntax ```text ecccontrol.SignerCertPublicKeyLength ``` ## Default Value 0 ## Remarks 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](#ecc-control) Control) The serial number of the certificate encoded as a string. ## Syntax ```text ecccontrol.SignerCertSerialNumber ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The text description of the certificate's signature algorithm. ## Syntax ```text ecccontrol.SignerCertSignatureAlgorithm ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The name of the certificate store for the client certificate. ## Syntax ```text ecccontrol.SignerCertStore[=string] ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SignerCertStoreType](#signercertstoretype-property-ecc-control) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-ecc-control). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-ecc-control). [SignerCertStore](#signercertstore-property-ecc-control) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-ecc-control) property to specify client certificates. If [SignerCertStore](#signercertstore-property-ecc-control) has a value, and [SignerCertSubject](#signercertsubject-property-ecc-control) or [SignerCertEncoded](#signercertencoded-property-ecc-control) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-ecc-control) 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). 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](#ecc-control) 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 ```text 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](#ecc-control) Control) The type of certificate store for this certificate. ## Syntax ```text ecccontrol.SignerCertStoreType[=integer] ``` ## Possible Values ```text 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 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SignerCertStoreType](#signercertstoretype-property-ecc-control), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-ecc-control), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-ecc-control). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) control by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SignerCertStore](#signercertstore-property-ecc-control) and set [SignerCertStorePassword](#signercertstorepassword-property-ecc-control) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 # SignerCertSubject Property ([ECC](#ecc-control) Control) The subject of the certificate used for client authentication. ## Syntax ```text ecccontrol.SignerCertSubject[=string] ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname 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 # SignerCertSubjectAltNames Property ([ECC](#ecc-control) Control) Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text ecccontrol.SignerCertSubjectAltNames ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SignerCertThumbprintMD5 Property ([ECC](#ecc-control) Control) The MD5 hash of the certificate. ## Syntax ```text ecccontrol.SignerCertThumbprintMD5 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The SHA-1 hash of the certificate. ## Syntax ```text ecccontrol.SignerCertThumbprintSHA1 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The SHA-256 hash of the certificate. ## Syntax ```text ecccontrol.SignerCertThumbprintSHA256 ``` ## Default Value "" ## Remarks 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](#ecc-control) Control) The text description of UsageFlags . ## Syntax ```text ecccontrol.SignerCertUsage ``` ## Default Value "" ## Remarks The text description of [SignerCertUsageFlags](#signercertusageflags-property-ecc-control). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # SignerCertUsageFlags Property ([ECC](#ecc-control) Control) The flags that show intended use for the certificate. ## Syntax ```text ecccontrol.SignerCertUsageFlags ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-ecc-control) 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](#signercertusage-property-ecc-control) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-ecc-control). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SignerCertVersion Property ([ECC](#ecc-control) Control) The certificate's version number. ## Syntax ```text ecccontrol.SignerCertVersion ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SignerKeyAlgorithm Property ([ECC](#ecc-control) Control) This property holds the algorithm associated with the key. ## Syntax ```text ecccontrol.SignerKeyAlgorithm[=integer] ``` ## Possible Values ```text 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](#ECC_p_SignerKeyPrivateKey) and [SignerKeyPublicKey](#signerkeypublickey-property-ecc-control), the [SignerKeyAlgorithm](#signerkeyalgorithm-property-ecc-control) property will be automatically updated with the key algorithm. When assigning a key using the raw key parameters ([SignerKeyK](#ECC_p_SignerKeyK), [SignerKeyRx](#signerkeyrx-property-ecc-control), and [SignerKeyRy](#signerkeyry-property-ecc-control) for NIST or [SignerKeyXPk](#signerkeyxpk-property-ecc-control), and [SignerKeyXSk](#ECC_p_SignerKeyXSk) for Curve25519/Curve448), the [SignerKeyAlgorithm](#signerkeyalgorithm-property-ecc-control) 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](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | Ed25519 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | Ed448 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | ## Data Type Integer # SignerKeyPublicKey Property ([ECC](#ecc-control) Control) This property is a PEM formatted public key. ## Syntax ```text 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](#ecc-control) Control) Represents the public key's Rx parameter. ## Syntax ```text 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](#ecc-control) Control) Represents the public key's Ry parameter. ## Syntax ```text 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](#ecc-control) Control) Holds the public key data. ## Syntax ```text 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](#ecc-control) Control) Whether binary values are hex encoded. ## Syntax ```text 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](#sharedsecret-property-ecc-control) is hex encoded when [ComputeSecret](#computesecret-method-ecc-control) is called. ### Sign and Verify Notes This property specifies whether [HashValue](#hashvalue-property-ecc-control) and [HashSignature](#hashsignature-property-ecc-control) are hex encoded. If set to True, when [Sign](#sign-method-ecc-control) is called the control will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ecc-control) with the hex encoded hash value. It will then create the hash signature and populate [HashSignature](#hashsignature-property-ecc-control) with the hex encoded hash signature value. If [HashValue](#hashvalue-property-ecc-control) is specified directly, it must be a hex encoded value. If set to True, when [VerifySignature](#verifysignature-method-ecc-control) is called the control will compute the hash value for the specified file and populate [HashValue](#hashvalue-property-ecc-control) with the hex encoded hash value. It will then hex decode [HashSignature](#hashsignature-property-ecc-control) and verify the signature. [HashSignature](#hashsignature-property-ecc-control) must hold a hex encoded value. If [HashValue](#hashvalue-property-ecc-control) is specified directly, it must be a hex encoded value. ### Encrypt and Decrypt Notes If set to True, when [Encrypt](#encrypt-method-ecc-control) is called the control will perform the encryption as normal and then hex encode the output. [OutputMessage](#outputmessage-property-ecc-control) or [OutputFile](#outputfile-property-ecc-control) will hold hex encoded data. If set to True, when [Decrypt](#decrypt-method-ecc-control) is called the control will expect [InputMessage](#inputmessage-property-ecc-control) or [InputFile](#inputfile-property-ecc-control) to hold hex encoded data. The control will then hex decode the data and perform decryption as normal. ## Data Type Boolean # ComputeSecret Method ([ECC](#ecc-control) Control) Computes a shared secret. ## Syntax ```text 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](#recipientkeypublickey-property-ecc-control) and the private key specified by Key to compute a shared secret, or secret agreement. The [ComputeSecretKDF](#computesecretkdf-property-ecc-control) property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by [SharedSecret](#sharedsecret-property-ecc-control). The following properties are applicable when calling this method: - Key (required) - [RecipientKeyPublicKey](#recipientkeypublickey-property-ecc-control) (required) - [ComputeSecretKDF](#computesecretkdf-property-ecc-control) (optional) See [ComputeSecretKDF](#computesecretkdf-property-ecc-control) 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** ```csharp //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](#ecc-control) Control) Sets or retrieves a configuration setting. ## Syntax ```text ecccontrol.Config ConfigurationString ``` ## Remarks Config is a generic method available in every control. It is used to set and retrieve [configuration settings](#config-settings-ecc-control) 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](#config-settings-ecc-control), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateKey Method ([ECC](#ecc-control) Control) Creates a new key. ## Syntax ```text 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](#keypublickey-property-ecc-control) and [KeyPrivateKey](#keyprivatekey-property-ecc-control) 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: | KeyAlgorithm | Supported Operations | | --- | --- | | secp256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-control)) | | Ed25519 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | Ed448 | EdDSA ([Sign](#sign-method-ecc-control) and [VerifySignature](#verifysignature-method-ecc-control)) | | secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | | brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-control), [Encrypt](#encrypt-method-ecc-control), [Decrypt](#decrypt-method-ecc-control), [Sign](#sign-method-ecc-control), and [VerifySignature](#verifysignature-method-ecc-control)) | **NIST, Koblitz, and Brainpool Curve Notes** Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters. The public key consists of the following parameters: - [KeyRx](#keyrx-property-ecc-control) - [KeyRy](#keyry-property-ecc-control) The private key consists of one value: - [KeyK](#keyk-property-ecc-control) **Curve25519 and Curve448 Notes** Keys for use with *Curve25519* or *Curve448* are made up of a private key and public key field. [KeyXPk](#keyxpk-property-ecc-control) holds the public key. [KeyXSk](#keyxsk-property-ecc-control) holds the private key. **Create Key Example (secp256r1 - PEM)** ```csharp //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)** ```csharp //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)** ```csharp //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)** ```csharp //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](#ecc-control) Control) Decrypted the specified data. ## Syntax ```text 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](#keyalgorithm-property-ecc-control) 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](#createkey-method-ecc-control) 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](#usehex-property-ecc-control) to True. The following properties are applicable when calling this method: - [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) - [HMACAlgorithm](#hmacalgorithm-property-ecc-control) - [HMACOptionalInfo](#HMACOptionalInfo) - [HMACKeySize](#HMACKeySize) - [IV](#iv-property-ecc-control) - [KDF](#kdf-property-ecc-control) - [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-control) - [KDFOptionalInfo](#KDFOptionalInfo) - [UseHex](#usehex-property-ecc-control) **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](#inputfile-property-ecc-control) - [InputMessage](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - [OutputMessage](#outputmessage-property-ecc-control): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt Example** ```csharp //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)** ```csharp //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)** ```csharp //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)** ```csharp //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](#ecc-control) Control) Encrypts the specified data. ## Syntax ```text 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](#keyalgorithm-property-ecc-control) 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](#createkey-method-ecc-control) 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](#usehex-property-ecc-control) to True. The following properties are applicable when calling this method: - [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) - [HMACAlgorithm](#hmacalgorithm-property-ecc-control) - [HMACOptionalInfo](#HMACOptionalInfo) - [HMACKeySize](#HMACKeySize) - [IV](#iv-property-ecc-control) - [KDF](#kdf-property-ecc-control) - [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-control) - [KDFOptionalInfo](#KDFOptionalInfo) - [UseHex](#usehex-property-ecc-control) **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](#inputfile-property-ecc-control) - [InputMessage](#inputmessage-property-ecc-control) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ecc-control) - [OutputMessage](#outputmessage-property-ecc-control): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt Example** ```csharp //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)** ```csharp //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)** ```csharp //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)** ```csharp //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](#ecc-control) Control) Resets the control. ## Syntax ```text ecccontrol.Reset ``` ## Remarks When called, the control will reset all of its properties to their default values. # Sign Method ([ECC](#ecc-control) Control) Creates a hash signature using ECDSA or EdDSA. ## Syntax ```text 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](#keyalgorithm-property-ecc-control) 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](#createkey-method-ecc-control) for details about key creation and algorithms. When this method is called, data will be read from the [InputFile](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control). The hash to be signed will be computed using the specified [HashAlgorithm](#hashalgorithm-property-ecc-control). The computed hash is stored in the [HashValue](#hashvalue-property-ecc-control) property. The signed hash is stored in the [HashSignature](#hashsignature-property-ecc-control) property. To sign a hash without first computing it, set [HashValue](#hashvalue-property-ecc-control) to a previously computed hash for the input data. Note: [HashValue](#hashvalue-property-ecc-control) is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448. The [Progress](#progress-event-ecc-control) 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](#hashsignature-property-ecc-control) 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](#hashalgorithm-property-ecc-control) (applicable to ECDSA only) - [HashEdDSA](#hasheddsa-property-ecc-control) (applicable to EdDSA only) - [HashValue](#hashvalue-property-ecc-control) (not applicable to PureEdDSA) - [UseHex](#usehex-property-ecc-control) The following properties are populated after calling this method: - [HashValue](#hashvalue-property-ecc-control) - [HashSignature](#hashsignature-property-ecc-control) When the [KeyAlgorithm](#keyalgorithm-property-ecc-control) is *Ed25519* or *Ed448*, the following additional parameters are applicable: - [HashEdDSA](#hasheddsa-property-ecc-control) - [EdDSAContext](#EdDSAContext) EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the [HashEdDSA](#hasheddsa-property-ecc-control) 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](#hashvalue-property-ecc-control) 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](#hasheddsa-property-ecc-control) to True. To specify context data when using *Ed25519* or *Ed448*, set [EdDSAContext](#EdDSAContext). **Sign And Verify Example (ECDSA)** ```csharp //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)** ```csharp //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)** ```csharp //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](#ecc-control) Control) Verifies the signature for the specified data. ## Syntax ```text 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](#inputfile-property-ecc-control) or [InputMessage](#inputmessage-property-ecc-control). 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](#hashsignature-property-ecc-control). When this method is called, the control will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ecc-control). It will verify the signature using the specified SignerKey and [HashSignature](#hashsignature-property-ecc-control). To verify the hash signature without first computing the hash, simply specify [HashValue](#hashvalue-property-ecc-control) before calling this method. Note: [HashValue](#hashvalue-property-ecc-control) is not applicable when the message was signed with a PureEdDSA algorithm such as *Ed25519* or *Ed448*. The [Progress](#progress-event-ecc-control) 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](#hashsignature-property-ecc-control) (required) - SignerKey (required) - [EdDSAContext](#EdDSAContext) (applicable to EdDSA only) - [HashAlgorithm](#hashalgorithm-property-ecc-control) (applicable to ECDSA only) - [HashEdDSA](#hasheddsa-property-ecc-control) (applicable to EdDSA only) - [HashValue](#hashvalue-property-ecc-control) (not applicable to PureEdDSA) - [UseHex](#usehex-property-ecc-control) **Sign And Verify Example (ECDSA)** ```csharp //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)** ```csharp //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)** ```csharp //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](#ecc-control) Control) Fired when information is available about errors during data delivery. ## Syntax ```text 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. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-ecc-control) section. # Progress Event ([ECC](#ecc-control) Control) Fired as progress is made. ## Syntax ```text 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](#ecc-control) 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](#config-method-ecc-control) method. ### ECC Config Settings **AppendSecret**: An optional string to append to the secret agreement.This setting specifies an optional string to append to the secret agreement before hashing it. This is applicable when calling [ComputeSecret](#computesecret-method-ecc-control). Note: This is not applicable when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to 12 (ekdTLS). **CNGECDHKey**: The CNG ECDH key.This setting may be set to specify the key exported from Microsoft's CNG before calling [ComputeSecret](#computesecret-method-ecc-control). If key data was obtained from Microsoft's CNG API, it can be hex encoded and supplied here. The control will use this key when [ComputeSecret](#computesecret-method-ecc-control) is called. **CNGECDSAKey**: The CNG ECDSA key.This setting may be set to specify the key exported from Microsoft's CNG before calling [VerifySignature](#verifysignature-method-ecc-control). If key data was obtained from Microsoft's CNG API, it can be hex encoded and supplied here. The control will use this key when [VerifySignature](#verifysignature-method-ecc-control) is called. **ConcatAlgorithmId**: The AlgorithmId subfield of the OtherInfo field.This setting specifies the AlgorithmId subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data. This setting is required when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **ConcatHashAlgorithm**: The hash algorithm to use when ComputeSecretKDF is Concat.This setting optionally specifies the hash algorithm to use when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to *ekdConcat*. Possible values are: - SHA1 - SHA224 - SHA256 (default) - SHA384 - SHA512 - RIPEMD160 **ConcatPartyUInfo**: The PartyUInfo subfield of the OtherInfo field.This setting specifies the PartyUInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data. This setting is required when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **ConcatPartyVInfo**: The PartyVInfo subfield of the OtherInfo field.This setting specifies the PartyVInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data. This setting is required when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **ConcatSuppPrivInfo**: The SuppPrivInfo subfield of the OtherInfo field.This setting specifies the SuppPrivInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data. This setting is optional when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **ConcatSuppPubInfo**: The SuppPubInfo subfield of the OtherInfo field.This setting specifies the SuppPubInfo subfield of the OtherInfo field as described in the publication "NIST SP 800-56A" section 5.8.1. The value supplied to this setting must be a hex encoded string of the subfield data. This setting is optional when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **ECDSASignatureFormat**: The format of the HashSignature when using ECDSA keys.This setting specifies the format of [HashSignature](#hashsignature-property-ecc-control) when signing with ECDSA keys. The way the [HashSignature](#hashsignature-property-ecc-control) parameters are represented can be changed to be interoperable with other implementations. Possible values are: - 0 (Concatenated - default) - 1 (ASN) Note: This setting is only applicable when [KeyAlgorithm](#keyalgorithm-property-ecc-control) is set to a NIST, Koblitz, or Brainpool curve. **EdDSAContext**: A hex encoded string holding the bytes of the context when signing or verifying with Ed25519ctx.This setting specifies up to 255 bytes of context data as a hex encoded string for signing and verifying. This setting is only applicable when [KeyAlgorithm](#keyalgorithm-property-ecc-control) is set to *Ed25519* or *Ed448*. When this setting is specified, the [KeyAlgorithm](#keyalgorithm-property-ecc-control) is *Ed25519*, and [HashEdDSA](#hasheddsa-property-ecc-control) is *False*, the control will automatically use *Ed25519ctx*. If this value is specified before calling [Sign](#sign-method-ecc-control), it must also be set prior to calling [VerifySignature](#verifysignature-method-ecc-control). **EncryptionKeySize**: The encryption key size.This setting specifies the AES encryption key size in bits when [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-control) is set to AES. Possible values are: - 128 - 192 - 256 (default) This setting is only applicable when calling [Encrypt](#encrypt-method-ecc-control). **HMACKey**: A key to use when generating a Hash-based Message Authentication Code (HMAC).This key is incorporated into the hashing process to add entropy to the resulting hash code, making the plaintext harder to guess and increasing the message security. The value supplied here must be hex encoded. This is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **HMACKeySize**: The HMAC key size to be used during encryption.This setting optionally specifies the HMAC key size to be used during encryption and decryption. If set to *0* (default), the control will automatically select the key size based on the algorithm specified in [HMACAlgorithm](#hmacalgorithm-property-ecc-control). This setting is only applicable when calling [Encrypt](#encrypt-method-ecc-control) or [Decrypt](#decrypt-method-ecc-control). **HMACOptionalInfo**: Optional data to be used during encryption and decryption during the HMAC step.This setting optionally specifies data to be used with the specified [HMACAlgorithm](#hmacalgorithm-property-ecc-control) as part of the encryption and decryption process. This is additional data known to both parties that is included while performing the HMAC operation. The value specified in this setting must a hex string. If specified, this must be set before calling both [Encrypt](#encrypt-method-ecc-control) and [Decrypt](#decrypt-method-ecc-control). **KDFOptionalInfo**: Optional data to be used during encryption and decryption during the key derivation step.This setting optionally specifies data to be used with the specified [KDF](#kdf-property-ecc-control) as part of the encryption and decryption process. This is additional data known to both parties that is included while performing key derivation. The value specified in this setting must a hex string. If specified, this must be set before calling both [Encrypt](#encrypt-method-ecc-control) and [Decrypt](#decrypt-method-ecc-control). **PrependSecret**: An optional string to prepend to the secret agreement.This setting specifies an optional string to prepend to the secret agreement before hashing it. This is applicable when calling [ComputeSecret](#computesecret-method-ecc-control). Note: This is not applicable when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to 12 (ekdTLS). **RawY**: The raw Y coordinate value.This is a read-only config that holds the value of a hex-encoded Y coordinate value with no secure key derivation functions applied. This config will only be used if [ComputeSecretKDF](#computesecretkdf-property-ecc-control) is set to Raw. This value will be set after calling [ComputeSecret](#computesecret-method-ecc-control) **StrictKeyValidation**: Whether to validate provided public keys based on private keys.This setting performs additional checks prior to using specified keys to validate that the public key corresponds to the provided private key. When using keys with the algorithm *Ed25519*, *Ed448*, *X25519*, or *X448*, the 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. **TLSLabel**: The TLS PRF label.This setting specifies a string representing the PRF label. This setting is required when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) set to 12 (ekdTLS). It is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). **TLSSeed**: The TLS PRF Seed.This setting specifies the hex encoded TLS PRF Seed. The seed value must be 64 bytes in length before hex encoding. This setting is required when [ComputeSecretKDF](#computesecretkdf-property-ecc-control) set to 12 (ekdTLS). It is only applicable when calling [ComputeSecret](#computesecret-method-ecc-control). ### Base Config Settings **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the control will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the control to use the internal implementation instead of using the system security libraries. This setting is set to *False* by default on all platforms. # Trappable Errors ([ECC](#ecc-control) 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. |