# ECC Class

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

## Syntax

```text
ECC
```

## Remarks

The ECC (Elliptic Curve Cryptography) class implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The class supports the following common operations:

- [CreateKey](#createkey-method-ecc-class) allows key creation using algorithms such as secp256r1, secp384r1, secp521r1, X25519, X448, Ed25519, Ed448, and more.
- [ComputeSecret](#computesecret-method-ecc-class) computes a shared secret between two parties using a public and private key (ECDH).
- [Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class) provides a way to digitally sign data and verify signatures (ECDSA and EdDSA).
- [Encrypt](#encrypt-method-ecc-class) and [Decrypt](#decrypt-method-ecc-class) encrypt and decrypt data using a public and private key (ECIES).

The class is very flexible and offers many properties and configuration settings to configure it. The sections below detail the use of the class for each of the major operations listed above.

### Key Creation and Management

[CreateKey](#createkey-method-ecc-class) creates a new public and private key.

When this method is called, [Key](#key-property-ecc-class) is populated with the generated key. The [PublicKey](#ECCKey_f_PublicKey) and [PrivateKey](#ECCKey_f_PrivateKey) fields 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-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-class)) |
| X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-class)) |
| Ed25519 | EdDSA ([Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class)) |
| Ed448 | EdDSA ([Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |

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

- [Rx](#ECCKey_f_Rx)
- [Ry](#ECCKey_f_Ry)

The private key consists of one value:

- [K](#ECCKey_f_K)

**Curve25519 and Curve448 Notes**

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

[XPk](#ECCKey_f_XPk) holds the public key.

[XSk](#ECCKey_f_XSk) 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 class will use the public key specified by [PublicKey](#ECCKey_f_PublicKey) and the private key specified by [Key](#key-property-ecc-class) to compute a shared secret, or secret agreement. The [ComputeSecretKDF](#computesecretkdf-property-ecc-class) property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by [SharedSecret](#sharedsecret-property-ecc-class). The following properties are applicable when calling this method:

- [Key](#key-property-ecc-class) (required)
- [PublicKey](#ECCKey_f_PublicKey) (required)
- [ComputeSecretKDF](#computesecretkdf-property-ecc-class) (optional)

See [ComputeSecretKDF](#computesecretkdf-property-ecc-class) 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-class) will create a hash signature using ECDSA or EdDSA. The class will use the key specified by [Key](#key-property-ecc-class) to hash the input data and sign the resulting hash.

[Key](#key-property-ecc-class) must contain a private key created with a valid ECDSA or EdDSA algorithm. [Algorithm](#ECCKey_f_Algorithm) 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-class) for details about key creation and algorithms.

When this method is called, data will be read from the [InputFile](#inputfile-property-ecc-class) or [InputMessage](#inputmessage-property-ecc-class).

The hash to be signed will be computed using the specified [HashAlgorithm](#hashalgorithm-property-ecc-class). The computed hash is stored in the [HashValue](#hashvalue-property-ecc-class) property. The signed hash is stored in the [HashSignature](#hashsignature-property-ecc-class) property.

To sign a hash without first computing it, set [HashValue](#hashvalue-property-ecc-class) to a previously computed hash for the input data. Note: [HashValue](#hashvalue-property-ecc-class) is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448.

The [Progress](#progress-event-ecc-class) 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-class), the public key must be sent to the recipient along with [HashSignature](#hashsignature-property-ecc-class) and the original input data so the other party may perform signature verification.

The following properties are applicable when calling this method:

- [Key](#key-property-ecc-class) (required)
- [HashAlgorithm](#hashalgorithm-property-ecc-class) (applicable to ECDSA only)
- [HashEdDSA](#hasheddsa-property-ecc-class) (applicable to EdDSA only)
- [HashValue](#hashvalue-property-ecc-class) (not applicable to PureEdDSA)
- [UseHex](#usehex-property-ecc-class)

The following properties are populated after calling this method:

- [HashValue](#hashvalue-property-ecc-class)
- [HashSignature](#hashsignature-property-ecc-class)

When the [Algorithm](#ECCKey_f_Algorithm) is *Ed25519* or *Ed448*, the following additional parameters are applicable:

- [HashEdDSA](#hasheddsa-property-ecc-class)
- [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-class) property. By default, the class uses the PureEdDSA algorithm.

The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, [HashValue](#hashvalue-property-ecc-class) 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-class) 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-class) 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-class) or [InputMessage](#inputmessage-property-ecc-class).

A public key and the hash signature are required to perform the signature verification. Specify the public key in [SignerKey](#signerkey-property-ecc-class). Specify the hash signature in [HashSignature](#hashsignature-property-ecc-class).

When this method is called, the class will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ecc-class). It will verify the signature using the specified [SignerKey](#signerkey-property-ecc-class) and [HashSignature](#hashsignature-property-ecc-class).

To verify the hash signature without first computing the hash, simply specify [HashValue](#hashvalue-property-ecc-class) before calling this method. Note: [HashValue](#hashvalue-property-ecc-class) is not applicable when the message was signed with a PureEdDSA algorithm such as *Ed25519* or *Ed448*.

The [Progress](#progress-event-ecc-class) 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-class) (required)
- [SignerKey](#signerkey-property-ecc-class) (required)
- [EdDSAContext](#EdDSAContext) (applicable to EdDSA only)
- [HashAlgorithm](#hashalgorithm-property-ecc-class) (applicable to ECDSA only)
- [HashEdDSA](#hasheddsa-property-ecc-class) (applicable to EdDSA only)
- [HashValue](#hashvalue-property-ecc-class) (not applicable to PureEdDSA)
- [UseHex](#usehex-property-ecc-class)

**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-class) encrypts the specified data with the ECDSA public key specified in [RecipientKey](#recipientkey-property-ecc-class).

Encryption is performed using ECIES which requires an ECDSA key. [RecipientKey](#recipientkey-property-ecc-class) must contain an ECDSA key. [Algorithm](#ECCKey_f_Algorithm) is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

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

See [CreateKey](#createkey-method-ecc-class) for details about key creation and algorithms.

When this method is called, the class will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output, set [UseHex](#usehex-property-ecc-class) to True.

The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class)
- [HMACAlgorithm](#hmacalgorithm-property-ecc-class)
- [HMACOptionalInfo](#HMACOptionalInfo)
- [HMACKeySize](#HMACKeySize)
- [IV](#iv-property-ecc-class)
- [KDF](#kdf-property-ecc-class)
- [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-class)
- [KDFOptionalInfo](#KDFOptionalInfo)
- [UseHex](#usehex-property-ecc-class)

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

**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-class) decrypts the specified data with the ECDSA private key specified in [Key](#key-property-ecc-class).

Decryption is performed using ECIES which requires an ECDSA key. [Key](#key-property-ecc-class) must contain an ECDSA key. [Algorithm](#ECCKey_f_Algorithm) is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

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

See [CreateKey](#createkey-method-ecc-class) for details about key creation and algorithms.

When this method is called, the class will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set [UseHex](#usehex-property-ecc-class) to True.

The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class)
- [HMACAlgorithm](#hmacalgorithm-property-ecc-class)
- [HMACOptionalInfo](#HMACOptionalInfo)
- [HMACKeySize](#HMACKeySize)
- [IV](#iv-property-ecc-class)
- [KDF](#kdf-property-ecc-class)
- [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-class)
- [KDFOptionalInfo](#KDFOptionalInfo)
- [UseHex](#usehex-property-ecc-class)

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

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

|  |  |
| --- | --- |
| [Certificate](#certificate-property-ecc-class) | The certificate used for signing and decryption. |
| [ComputeSecretKDF](#computesecretkdf-property-ecc-class) | The key derivation function. |
| [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class) | The encryption algorithm to use. |
| [HashAlgorithm](#hashalgorithm-property-ecc-class) | The hash algorithm used for hash computation. |
| [HashEdDSA](#hasheddsa-property-ecc-class) | Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key. |
| [HashSignature](#hashsignature-property-ecc-class) | The hash signature. |
| [HashValue](#hashvalue-property-ecc-class) | The hash value of the data. |
| [HMACAlgorithm](#hmacalgorithm-property-ecc-class) | The HMAC algorithm to use during encryption. |
| [InputFile](#inputfile-property-ecc-class) | The file to process. |
| [InputMessage](#inputmessage-property-ecc-class) | The message to process. |
| [IV](#iv-property-ecc-class) | The initialization vector (IV) used when encrypting. |
| [KDF](#kdf-property-ecc-class) | The key derivation function used during encryption and decryption. |
| [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-class) | The KDF hash algorithm to use when encrypting and decrypting. |
| [Key](#key-property-ecc-class) | The ECC key. |
| [OutputFile](#outputfile-property-ecc-class) | The output file when encrypting or decrypting. |
| [OutputMessage](#outputmessage-property-ecc-class) | The output message when encrypting or decrypting. |
| [Overwrite](#overwrite-property-ecc-class) | Indicates whether or not the class should overwrite files. |
| [RecipientCert](#recipientcert-property-ecc-class) | The certificate used for encryption and computing a shared secret. |
| [RecipientKey](#recipientkey-property-ecc-class) | The public key used to compute the shared secret. |
| [SharedSecret](#sharedsecret-property-ecc-class) | The computed shared secret. |
| [SignerCert](#signercert-property-ecc-class) | The certificate used for signature verification. |
| [SignerKey](#signerkey-property-ecc-class) | The public key used to verify the signature. |
| [UseHex](#usehex-property-ecc-class) | Whether binary values are hex encoded. |

## Method List

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

|  |  |
| --- | --- |
| [ComputeSecret](#computesecret-method-ecc-class) | Computes a shared secret. |
| [Config](#config-method-ecc-class) | Sets or retrieves a configuration setting. |
| [CreateKey](#createkey-method-ecc-class) | Creates a new key. |
| [Decrypt](#decrypt-method-ecc-class) | Decrypted the specified data. |
| [Encrypt](#encrypt-method-ecc-class) | Encrypts the specified data. |
| [Reset](#reset-method-ecc-class) | Resets the class. |
| [SetInputStream](#setinputstream-method-ecc-class) | Sets the stream from which the class will read data to encrypt or decrypt. |
| [SetOutputStream](#setoutputstream-method-ecc-class) | Sets the stream to which the class will write encrypted or decrypted data. |
| [Sign](#sign-method-ecc-class) | Creates a hash signature using ECDSA or EdDSA. |
| [VerifySignature](#verifysignature-method-ecc-class) | Verifies the signature for the specified data. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#error-event-ecc-class) | Fired when information is available about errors during data delivery. |
| [Progress](#progress-event-ecc-class) | Fired as progress is made. |

## Config Settings

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

|  |  |
| --- | --- |
| [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. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Certificate Property ([ECC](#ecc-class) Class)

The certificate used for signing and decryption.

## Syntax

```text
IPWorksEncryptCertificate* GetCertificate();
int SetCertificate(IPWorksEncryptCertificate* val);
```

## Remarks

This property specifies a certificate with a private key.

This may be set instead of [Key](#key-property-ecc-class), allowing a [Certificate](#certificate-type) object to be used instead of a [ECCKey](#ecckey-type) object. This certificate is used when calling [Sign](#sign-method-ecc-class) and [Decrypt](#decrypt-method-ecc-class). The specified certificate must have a private key.

If both this property and [Key](#key-property-ecc-class) are specified, [Key](#key-property-ecc-class) will be used and this property will be ignored.

## Data Type

[IPWorksEncryptCertificate](#certificate-type)

# ComputeSecretKDF Property ([ECC](#ecc-class) Class)

The key derivation function.

## Syntax

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

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

## Possible Values

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

## Default Value

1

## Remarks

This property specifies the key derivation function (KDF) and algorithm to use when calling [ComputeSecret](#computesecret-method-ecc-class).

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

The encryption algorithm to use.

## Syntax

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

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

## Possible Values

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

## Default Value

0

## Remarks

This setting specifies the encryption algorithm to use when [Encrypt](#encrypt-method-ecc-class) is called. This must also be set before calling [Decrypt](#decrypt-method-ecc-class) 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-class) Class)

The hash algorithm used for hash computation.

## Syntax

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

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

## Possible Values

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

## Default Value

2

## Remarks

This property specifies the hash algorithm used for hash computation. This is only applicable when calling [Sign](#sign-method-ecc-class) or [VerifySignature](#verifysignature-method-ecc-class) and [Algorithm](#ECCKey_f_Algorithm) 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 [Algorithm](#ECCKey_f_Algorithm) 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-class) Class)

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

## Syntax

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

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

## Default Value

FALSE

## Remarks

This setting specifies whether to use the HashEdDSA algorithm when signing and verifying with *Ed25519* or *Ed448* keys.

If set to *True*, the class will use the HashEdDSA algorithm (*Ed25519ph* or *Ed448ph*) when signing and verifying. When using a HashEdDSA algorithm, the input is pre-hashed and supports a single pass over the data during the signing operation.

If set to *False* (default), the class will use the PureEdDSA algorithm (*Ed25519* or *Ed448*) when signing. The PureEdDSA requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means 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-class) and [Algorithm](#ECCKey_f_Algorithm) is set to *Ed25519* or *Ed448*.

If this property is set before calling [Sign](#sign-method-ecc-class), it must be set before calling [VerifySignature](#verifysignature-method-ecc-class).

## Data Type

Boolean

# HashSignature Property ([ECC](#ecc-class) Class)

The hash signature.

## Syntax

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

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

## Default Value

""

## Remarks

This property holds the computed hash signature. This is populated after calling [Sign](#sign-method-ecc-class). This must be set before calling [VerifySignature](#verifysignature-method-ecc-class).

## Data Type

Binary String

# HashValue Property ([ECC](#ecc-class) Class)

The hash value of the data.

## Syntax

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

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

## Default Value

""

## Remarks

This property holds the computed hash value for the specified data. This is populated when calling [Sign](#sign-method-ecc-class) or [VerifySignature](#verifysignature-method-ecc-class) when an input file is specified by setting [InputFile](#inputfile-property-ecc-class) or [InputMessage](#inputmessage-property-ecc-class).

Pre-existing hash values may be set to this property before calling [Sign](#sign-method-ecc-class) or [VerifySignature](#verifysignature-method-ecc-class). If you know the hash value prior to using the class, you may specify the pre-computed hash value here.

This setting is not applicable to PureEdDSA algorithms. If [Algorithm](#ECCKey_f_Algorithm) is *Ed25519* or *Ed448* and [HashEdDSA](#hasheddsa-property-ecc-class) is False (default), the PureEdDSA algorithm is used and HashValue is not applicable.

**Hash Notes**

The class will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by [InputFile](#inputfile-property-ecc-class) or [InputMessage](#inputmessage-property-ecc-class), the hash will be recomputed when calling [Sign](#sign-method-ecc-class) or [VerifySignature](#verifysignature-method-ecc-class). If the HashValue property is set, the class will only sign the hash or verify the hash signature. Setting [InputFile](#inputfile-property-ecc-class) or [InputMessage](#inputmessage-property-ecc-class) clears the HashValue property. Setting the HashValue property clears the input file selection.

## Data Type

Binary String

# HMACAlgorithm Property ([ECC](#ecc-class) Class)

The HMAC algorithm to use during encryption.

## Syntax

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

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

## Possible Values

```text
IES_HMACSHA1(0), IES_HMACSHA224(1), IES_HMACSHA256(2), IES_HMACSHA384(3), IES_HMACSHA512(4), IES_HMACRIPEMD160(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-class) and [Decrypt](#decrypt-method-ecc-class) 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-class) or [Decrypt](#decrypt-method-ecc-class).

## Data Type

Integer

# InputFile Property ([ECC](#ecc-class) Class)

The file to process.

## Syntax

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

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

## Default Value

""

## Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- InputFile
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Data Type

String

# InputMessage Property ([ECC](#ecc-class) Class)

The message to process.

## Syntax

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

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

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- InputMessage

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Data Type

Binary String

# IV Property ([ECC](#ecc-class) Class)

The initialization vector (IV) used when encrypting.

## Syntax

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

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

## Default Value

""

## Remarks

This property optionally specifies an IV to be used when calling [Encrypt](#encrypt-method-ecc-class) or [Decrypt](#decrypt-method-ecc-class). If specified, the IV is used by [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class) during encryption.

If not specified, the class will create an IV filled with null bytes (zeros). Since the encryption key is only used once, the use of null bytes in the IV is considered acceptable and is a standard practice.

The length of the IV should be as follows:

|  |  |
| --- | --- |
| [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class) | IV Length (in bytes) |
| AES | 16 |
| 3DES | 8 |

This setting is not applicable when [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class) is set to *XOR*.

## Data Type

Binary String

# KDF Property ([ECC](#ecc-class) Class)

The key derivation function used during encryption and decryption.

## Syntax

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

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

## 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-class) specifies the hash algorithm used in conjunction with the specified KDF.

This property is only applicable when calling [Encrypt](#encrypt-method-ecc-class) or [Decrypt](#decrypt-method-ecc-class).

## Data Type

String

# KDFHashAlgorithm Property ([ECC](#ecc-class) Class)

The KDF hash algorithm to use when encrypting and decrypting.

## Syntax

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

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

## Possible Values

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

## Default Value

2

## Remarks

This property specifies the hash algorithm to use when deriving a key using the specified [KDF](#kdf-property-ecc-class). Possible values are:

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

This property is only applicable when calling [Encrypt](#encrypt-method-ecc-class) or [Decrypt](#decrypt-method-ecc-class).

## Data Type

Integer

# Key Property ([ECC](#ecc-class) Class)

The ECC key.

## Syntax

```text
IPWorksEncryptECCKey* GetKey();
int SetKey(IPWorksEncryptECCKey* val);
```

## Remarks

This property specifies the ECC private key. This property must be set before calling [Sign](#sign-method-ecc-class) or [ComputeSecret](#computesecret-method-ecc-class).

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

- [Rx](#ECCKey_f_Rx)
- [Ry](#ECCKey_f_Ry)

The private key consists of one value:

- [K](#ECCKey_f_K)

**Curve25519 and Curve448 Notes**

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

[XPk](#ECCKey_f_XPk) holds the public key.

[XSk](#ECCKey_f_XSk) holds the private key.

## Data Type

[IPWorksEncryptECCKey](#ecckey-type)

# OutputFile Property ([ECC](#ecc-class) Class)

The output file when encrypting or decrypting.

## Syntax

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

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

## Default Value

""

## Remarks

This property specifies the file to which the output will be written when [Encrypt](#encrypt-method-ecc-class) or [Decrypt](#decrypt-method-ecc-class) is called. This may be set to an absolute or relative path.

This property is only applicable to [Encrypt](#encrypt-method-ecc-class) and [Decrypt](#decrypt-method-ecc-class).

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- OutputFile
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Data Type

String

# OutputMessage Property ([ECC](#ecc-class) Class)

The output message when encrypting or decrypting.

## Syntax

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

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

## Default Value

""

## Remarks

This property will be populated with the output after calling [Encrypt](#encrypt-method-ecc-class) or [Decrypt](#decrypt-method-ecc-class) if [OutputFile](#outputfile-property-ecc-class) is not set.

This property is only applicable to [Encrypt](#encrypt-method-ecc-class) and [Decrypt](#decrypt-method-ecc-class).

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

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

## Data Type

Binary String

# Overwrite Property ([ECC](#ecc-class) Class)

Indicates whether or not the class should overwrite files.

## Syntax

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

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

## Default Value

FALSE

## Remarks

This property indicates whether or not the class will overwrite [OutputFile](#outputfile-property-ecc-class). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-ecc-class) exists before an operation. The default value is False.

## Data Type

Boolean

# RecipientCert Property ([ECC](#ecc-class) Class)

The certificate used for encryption and computing a shared secret.

## Syntax

```text
IPWorksEncryptCertificate* GetRecipientCert();
int SetRecipientCert(IPWorksEncryptCertificate* val);
```

## Remarks

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

This may be set instead of [RecipientKey](#recipientkey-property-ecc-class), allowing a [Certificate](#certificate-type) object to be used instead of a [ECCKey](#ecckey-type) object. This certificate is used when calling [Encrypt](#encrypt-method-ecc-class) and [ComputeSecret](#computesecret-method-ecc-class).

If both this property and [RecipientKey](#recipientkey-property-ecc-class) are specified, [RecipientKey](#recipientkey-property-ecc-class) will be used and this property will be ignored.

## Data Type

[IPWorksEncryptCertificate](#certificate-type)

# RecipientKey Property ([ECC](#ecc-class) Class)

The public key used to compute the shared secret.

## Syntax

```text
IPWorksEncryptECCKey* GetRecipientKey();
int SetRecipientKey(IPWorksEncryptECCKey* val);
```

## Remarks

This property specifies the public key used to compute the shared secret. If [RecipientCert](#recipientcert-property-ecc-class) is not specified, this must be set before calling [ComputeSecret](#computesecret-method-ecc-class).

## Data Type

[IPWorksEncryptECCKey](#ecckey-type)

# SharedSecret Property ([ECC](#ecc-class) Class)

The computed shared secret.

## Syntax

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

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

## Default Value

""

## Remarks

This property holds the shared secret computed by [ComputeSecret](#computesecret-method-ecc-class).

This property is read-only.

## Data Type

Binary String

# SignerCert Property ([ECC](#ecc-class) Class)

The certificate used for signature verification.

## Syntax

```text
IPWorksEncryptCertificate* GetSignerCert();
int SetSignerCert(IPWorksEncryptCertificate* val);
```

## Remarks

This property specifies a certificate for signature verification.

This may be set instead of [SignerKey](#signerkey-property-ecc-class), allowing a [Certificate](#certificate-type) object to be used instead of a [ECCKey](#ecckey-type) object. This certificate is used when calling [VerifySignature](#verifysignature-method-ecc-class).

If both this property and [SignerKey](#signerkey-property-ecc-class) are specified, [SignerKey](#signerkey-property-ecc-class) will be used and this property will be ignored.

## Data Type

[IPWorksEncryptCertificate](#certificate-type)

# SignerKey Property ([ECC](#ecc-class) Class)

The public key used to verify the signature.

## Syntax

```text
IPWorksEncryptECCKey* GetSignerKey();
int SetSignerKey(IPWorksEncryptECCKey* val);
```

## Remarks

This property specifies the public key used to verify the signature. This public key corresponds to the private key used when creating the signature. This must be set before calling [VerifySignature](#verifysignature-method-ecc-class).

## Data Type

[IPWorksEncryptECCKey](#ecckey-type)

# UseHex Property ([ECC](#ecc-class) Class)

Whether binary values are hex encoded.

## Syntax

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

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

## Default Value

FALSE

## Remarks

This setting specifies whether various calculated values are hex encoded. If set to *False* (default), all data is provided as-is with no encoding.

If set to *True*, certain properties are hex encoded when populated for ease of display, transport, and storage.

### Compute Secret Notes

This property specifies whether [SharedSecret](#sharedsecret-property-ecc-class) is hex encoded when [ComputeSecret](#computesecret-method-ecc-class) is called.

### Sign and Verify Notes

This property specifies whether [HashValue](#hashvalue-property-ecc-class) and [HashSignature](#hashsignature-property-ecc-class) are hex encoded.

If set to True, when [Sign](#sign-method-ecc-class) is called the class will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ecc-class) with the hex encoded hash value. It will then create the hash signature and populate [HashSignature](#hashsignature-property-ecc-class) with the hex encoded hash signature value. If [HashValue](#hashvalue-property-ecc-class) is specified directly, it must be a hex encoded value.

If set to True, when [VerifySignature](#verifysignature-method-ecc-class) is called the class will compute the hash value for the specified file and populate [HashValue](#hashvalue-property-ecc-class) with the hex encoded hash value. It will then hex decode [HashSignature](#hashsignature-property-ecc-class) and verify the signature. [HashSignature](#hashsignature-property-ecc-class) must hold a hex encoded value. If [HashValue](#hashvalue-property-ecc-class) is specified directly, it must be a hex encoded value.

### Encrypt and Decrypt Notes

If set to True, when [Encrypt](#encrypt-method-ecc-class) is called the class will perform the encryption as normal and then hex encode the output. [OutputMessage](#outputmessage-property-ecc-class) or [OutputFile](#outputfile-property-ecc-class) will hold hex encoded data.

If set to True, when [Decrypt](#decrypt-method-ecc-class) is called the class will expect [InputMessage](#inputmessage-property-ecc-class) or [InputFile](#inputfile-property-ecc-class) to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

## Data Type

Boolean

# ComputeSecret Method ([ECC](#ecc-class) Class)

Computes a shared secret.

## Syntax

```text
ANSI (Cross Platform)
int ComputeSecret();

Unicode (Windows)
INT ComputeSecret();
```

## Remarks

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

When this method is called, the class will use the public key specified by [PublicKey](#ECCKey_f_PublicKey) and the private key specified by [Key](#key-property-ecc-class) to compute a shared secret, or secret agreement. The [ComputeSecretKDF](#computesecretkdf-property-ecc-class) property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by [SharedSecret](#sharedsecret-property-ecc-class). The following properties are applicable when calling this method:

- [Key](#key-property-ecc-class) (required)
- [PublicKey](#ECCKey_f_PublicKey) (required)
- [ComputeSecretKDF](#computesecretkdf-property-ecc-class) (optional)

See [ComputeSecretKDF](#computesecretkdf-property-ecc-class) 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.
```

## Error Handling (C++)

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

# Config Method ([ECC](#ecc-class) Class)

Sets or retrieves a configuration setting.

## Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-ecc-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-ecc-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

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

# CreateKey Method ([ECC](#ecc-class) Class)

Creates a new key.

## Syntax

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

Unicode (Windows)
INT CreateKey(LPCWSTR lpszKeyAlgorithm);
```

## Remarks

CreateKey creates a new public and private key.

When this method is called, [Key](#key-property-ecc-class) is populated with the generated key. The [PublicKey](#ECCKey_f_PublicKey) and [PrivateKey](#ECCKey_f_PrivateKey) fields 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-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-class)) |
| X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-class)) |
| Ed25519 | EdDSA ([Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class)) |
| Ed448 | EdDSA ([Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |

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

- [Rx](#ECCKey_f_Rx)
- [Ry](#ECCKey_f_Ry)

The private key consists of one value:

- [K](#ECCKey_f_K)

**Curve25519 and Curve448 Notes**

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

[XPk](#ECCKey_f_XPk) holds the public key.

[XSk](#ECCKey_f_XSk) 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"
```

## Error Handling (C++)

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

# Decrypt Method ([ECC](#ecc-class) Class)

Decrypted the specified data.

## Syntax

```text
ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();
```

## Remarks

Decrypt decrypts the specified data with the ECDSA private key specified in [Key](#key-property-ecc-class).

Decryption is performed using ECIES which requires an ECDSA key. [Key](#key-property-ecc-class) must contain an ECDSA key. [Algorithm](#ECCKey_f_Algorithm) is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

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

See [CreateKey](#createkey-method-ecc-class) for details about key creation and algorithms.

When this method is called, the class will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set [UseHex](#usehex-property-ecc-class) to True.

The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class)
- [HMACAlgorithm](#hmacalgorithm-property-ecc-class)
- [HMACOptionalInfo](#HMACOptionalInfo)
- [HMACKeySize](#HMACKeySize)
- [IV](#iv-property-ecc-class)
- [KDF](#kdf-property-ecc-class)
- [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-class)
- [KDFOptionalInfo](#KDFOptionalInfo)
- [UseHex](#usehex-property-ecc-class)

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

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

## Error Handling (C++)

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

# Encrypt Method ([ECC](#ecc-class) Class)

Encrypts the specified data.

## Syntax

```text
ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();
```

## Remarks

Encrypt encrypts the specified data with the ECDSA public key specified in [RecipientKey](#recipientkey-property-ecc-class).

Encryption is performed using ECIES which requires an ECDSA key. [RecipientKey](#recipientkey-property-ecc-class) must contain an ECDSA key. [Algorithm](#ECCKey_f_Algorithm) is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:

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

See [CreateKey](#createkey-method-ecc-class) for details about key creation and algorithms.

When this method is called, the class will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output, set [UseHex](#usehex-property-ecc-class) to True.

The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class)
- [HMACAlgorithm](#hmacalgorithm-property-ecc-class)
- [HMACOptionalInfo](#HMACOptionalInfo)
- [HMACKeySize](#HMACKeySize)
- [IV](#iv-property-ecc-class)
- [KDF](#kdf-property-ecc-class)
- [KDFHashAlgorithm](#kdfhashalgorithm-property-ecc-class)
- [KDFOptionalInfo](#KDFOptionalInfo)
- [UseHex](#usehex-property-ecc-class)

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

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

## Error Handling (C++)

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

# Reset Method ([ECC](#ecc-class) Class)

Resets the class.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

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

## Error Handling (C++)

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

# SetInputStream Method ([ECC](#ecc-class) Class)

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

## Syntax

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

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

## Remarks

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

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- SetInputStream
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- [SetOutputStream](#setoutputstream-method-ecc-class)
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Error Handling (C++)

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

# SetOutputStream Method ([ECC](#ecc-class) Class)

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

## Syntax

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

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

## Remarks

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

**Input and Output Properties**

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [SetInputStream](#setinputstream-method-ecc-class)
- [InputFile](#inputfile-property-ecc-class)
- [InputMessage](#inputmessage-property-ecc-class)

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

- SetOutputStream
- [OutputFile](#outputfile-property-ecc-class)
- [OutputMessage](#outputmessage-property-ecc-class): The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Error Handling (C++)

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

# Sign Method ([ECC](#ecc-class) Class)

Creates a hash signature using ECDSA or EdDSA.

## Syntax

```text
ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();
```

## Remarks

Sign will create a hash signature using ECDSA or EdDSA. The class will use the key specified by [Key](#key-property-ecc-class) to hash the input data and sign the resulting hash.

[Key](#key-property-ecc-class) must contain a private key created with a valid ECDSA or EdDSA algorithm. [Algorithm](#ECCKey_f_Algorithm) 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-class) for details about key creation and algorithms.

When this method is called, data will be read from the [InputFile](#inputfile-property-ecc-class) or [InputMessage](#inputmessage-property-ecc-class).

The hash to be signed will be computed using the specified [HashAlgorithm](#hashalgorithm-property-ecc-class). The computed hash is stored in the [HashValue](#hashvalue-property-ecc-class) property. The signed hash is stored in the [HashSignature](#hashsignature-property-ecc-class) property.

To sign a hash without first computing it, set [HashValue](#hashvalue-property-ecc-class) to a previously computed hash for the input data. Note: [HashValue](#hashvalue-property-ecc-class) is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448.

The [Progress](#progress-event-ecc-class) 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-class) and the original input data so the other party may perform signature verification.

The following properties are applicable when calling this method:

- [Key](#key-property-ecc-class) (required)
- [HashAlgorithm](#hashalgorithm-property-ecc-class) (applicable to ECDSA only)
- [HashEdDSA](#hasheddsa-property-ecc-class) (applicable to EdDSA only)
- [HashValue](#hashvalue-property-ecc-class) (not applicable to PureEdDSA)
- [UseHex](#usehex-property-ecc-class)

The following properties are populated after calling this method:

- [HashValue](#hashvalue-property-ecc-class)
- [HashSignature](#hashsignature-property-ecc-class)

When the [Algorithm](#ECCKey_f_Algorithm) is *Ed25519* or *Ed448*, the following additional parameters are applicable:

- [HashEdDSA](#hasheddsa-property-ecc-class)
- [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-class) property. By default, the class uses the PureEdDSA algorithm.

The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, [HashValue](#hashvalue-property-ecc-class) 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-class) 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();
```

## Error Handling (C++)

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

# VerifySignature Method ([ECC](#ecc-class) Class)

Verifies the signature for the specified data.

## Syntax

```text
ANSI (Cross Platform)
bool VerifySignature();

Unicode (Windows)
bool VerifySignature();
```

## Remarks

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

Before calling this method, specify the input file by setting [InputFile](#inputfile-property-ecc-class) or [InputMessage](#inputmessage-property-ecc-class).

A public key and the hash signature are required to perform the signature verification. Specify the public key in [SignerKey](#signerkey-property-ecc-class). Specify the hash signature in [HashSignature](#hashsignature-property-ecc-class).

When this method is called, the class will compute the hash for the specified file and populate [HashValue](#hashvalue-property-ecc-class). It will verify the signature using the specified [SignerKey](#signerkey-property-ecc-class) and [HashSignature](#hashsignature-property-ecc-class).

To verify the hash signature without first computing the hash, simply specify [HashValue](#hashvalue-property-ecc-class) before calling this method. Note: [HashValue](#hashvalue-property-ecc-class) is not applicable when the message was signed with a PureEdDSA algorithm such as *Ed25519* or *Ed448*.

The [Progress](#progress-event-ecc-class) 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-class) (required)
- [SignerKey](#signerkey-property-ecc-class) (required)
- [EdDSAContext](#EdDSAContext) (applicable to EdDSA only)
- [HashAlgorithm](#hashalgorithm-property-ecc-class) (applicable to ECDSA only)
- [HashEdDSA](#hasheddsa-property-ecc-class) (applicable to EdDSA only)
- [HashValue](#hashvalue-property-ecc-class) (not applicable to PureEdDSA)
- [UseHex](#usehex-property-ecc-class)

**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 Handling (C++)

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

# Error Event ([ECC](#ecc-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(ECCErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} ECCErrorEventParams;

Unicode (Windows)
virtual INT FireError(ECCErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} ECCErrorEventParams;
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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-class) section.

# Progress Event ([ECC](#ecc-class) Class)

Fired as progress is made.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireProgress(ECCProgressEventParams *e);
typedef struct {  int64 BytesProcessed;  int PercentProcessed;
  int reserved;
} ECCProgressEventParams;

Unicode (Windows)
virtual INT FireProgress(ECCProgressEventParams *e);
typedef struct {  LONG64 BytesProcessed;  INT PercentProcessed;
  INT reserved;
} ECCProgressEventParams;
```

## Remarks

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

The *PercentProcessed* parameter indicates the current status of the operation.

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

# Certificate Type

This is the digital certificate being used.

## Syntax

 *IPWorksEncryptCertificate* (declared in *ipworksencrypt.h*)

## Remarks

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

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *char* (read-only)*
*Default Value: ""*

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

23-Jan-2000 15:00:00.

 **ExpirationDate** *char* (read-only)*
*Default Value: ""*

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

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *char* (read-only)*
*Default Value: ""*

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

 **Fingerprint** *char* (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA1** *char* (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA256** *char* (read-only)*
*Default Value: ""*

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

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

 **Issuer** *char* (read-only)*
*Default Value: ""*

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

 **PrivateKey** *char* (read-only)*
*Default Value: ""*

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

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *int (read-only)*
*Default Value: FALSE*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *char* (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *char* (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *char* (read-only)*
*Default Value: ""*

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

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

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

 **SerialNumber** *char* (read-only)*
*Default Value: ""*

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

 **SignatureAlgorithm** *char* (read-only)*
*Default Value: ""*

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

 **Store** *char**
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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).

 **StorePassword** *char**
*Default Value: ""*

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

 **StoreType** *int*
*Default Value: 0*

The type of certificate store for this certificate.

 The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field 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](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#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 [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) 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. |

 **SubjectAltNames** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA1** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA256** *char* (read-only)*
*Default Value: ""*

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

 **Usage** *char* (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_UsageFlags).

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

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

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

 **UsageFlags** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) 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 [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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

 **Version** *char* (read-only)*
*Default Value: ""*

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

 **Subject** *char**
*Default Value: ""*

The subject of the certificate used for client authentication.

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

If a matching certificate is found, the field 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.

 **Encoded** *char**
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
Certificate()
```

 Creates a instance whose properties can be set.

```text
Certificate(const char* lpEncoded, int lenEncoded)
```

 Parses * Encoded * as an X.509 public key.

```text
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
```

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

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

# ECCKey Type

Contains the parameters for the ECC algorithm.

## Syntax

 *IPWorksEncryptECCKey* (declared in *ipworksencrypt.h*)

## Remarks

This type is made up of fields that represent the private and public key parameters used by the ECC operations. The [PrivateKey](#ECCKey_f_PrivateKey) and [PublicKey](#ECCKey_f_PublicKey) parameters hold a PEM formatted value for easy transport and storage of keys.

**NIST, Koblitz, and Brainpool Curve Notes**

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

The public key consists of the following parameters:

- [Rx](#ECCKey_f_Rx)
- [Ry](#ECCKey_f_Ry)

The private key consists of one value:

- [K](#ECCKey_f_K)

**Curve25519 and Curve448 Notes**

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

[XPk](#ECCKey_f_XPk) holds the public key.

[XSk](#ECCKey_f_XSk) holds the private key.

The following fields are available:

- [Algorithm](#ECCKey_f_Algorithm)

- [K](#ECCKey_f_K)

- [PrivateKey](#ECCKey_f_PrivateKey)

- [PublicKey](#ECCKey_f_PublicKey)

- [Rx](#ECCKey_f_Rx)

- [Ry](#ECCKey_f_Ry)

- [XPk](#ECCKey_f_XPk)

- [XSk](#ECCKey_f_XSk)

## Fields

 **Algorithm** *int*
*Default Value: 0*

This field 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 [PrivateKey](#ECCKey_f_PrivateKey) and [PublicKey](#ECCKey_f_PublicKey), the [Algorithm](#ECCKey_f_Algorithm) field will be automatically updated with the key algorithm.

When assigning a key using the raw key parameters ([K](#ECCKey_f_K), [Rx](#ECCKey_f_Rx), and [Ry](#ECCKey_f_Ry) for NIST or [XPk](#ECCKey_f_XPk), and [XSk](#ECCKey_f_XSk) for Curve25519/Curve448), the [Algorithm](#ECCKey_f_Algorithm) field 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-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp521r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| X25519 | ECDH ([ComputeSecret](#computesecret-method-ecc-class)) |
| X448 | ECDH ([ComputeSecret](#computesecret-method-ecc-class)) |
| Ed25519 | EdDSA ([Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class)) |
| Ed448 | EdDSA ([Sign](#sign-method-ecc-class) and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp160k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp192k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp224k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| secp256k1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP160r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP192r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP224r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP256r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP320r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP384r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP512r1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP160t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP192t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP224t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP256t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP320t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP384t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |
| brainpoolP512t1 | ECDH/ECIES/ECDSA ([ComputeSecret](#computesecret-method-ecc-class), [Encrypt](#encrypt-method-ecc-class), [Decrypt](#decrypt-method-ecc-class), [Sign](#sign-method-ecc-class), and [VerifySignature](#verifysignature-method-ecc-class)) |

 **K** *char**
*Default Value: ""*

Represents the private key (K) parameter.

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

 **PrivateKey** *char**
*Default Value: ""*

This field is a PEM formatted private key. The purpose of this field is to allow easier management of the private key parameters by using only a single value.

 **PublicKey** *char**
*Default Value: ""*

This field is a PEM formatted public key. The purpose of this field is to allow easier management of the public key parameters by using only a single value.

 **Rx** *char**
*Default Value: ""*

Represents the public key's Rx parameter.

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

 **Ry** *char**
*Default Value: ""*

Represents the public key's Ry parameter.

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

 **XPk** *char**
*Default Value: ""*

Holds the public key data.

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

 **XSk** *char**
*Default Value: ""*

Holds the private key data.

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

## Constructors

```text
ECCKey()
```

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

```text
ECCKey(const char* lpRx, int lenRx, const char* lpRy, int lenRy, int iAlgorithm)
```

 The public key constructor assigns an existing public key.

```text
ECCKey(const char* lpK, int lenK, const char* lpRx, int lenRx, const char* lpRy, int lenRy, int iAlgorithm)
```

 The private key constructor assigns an existing private key.

# IPWorksEncryptStream Type

## Syntax

 *IPWorksEncryptStream* (declared in *ipworksencrypt.h*)

## Remarks

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

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

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

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

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

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

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when an IPWorksEncryptStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([ECC](#ecc-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-ecc-class) 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-class).

Note: This is not applicable when [ComputeSecretKDF](#computesecretkdf-property-ecc-class) 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-class). If key data was obtained from Microsoft's CNG API, it can be hex encoded and supplied here. The class will use this key when [ComputeSecret](#computesecret-method-ecc-class) 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-class). If key data was obtained from Microsoft's CNG API, it can be hex encoded and supplied here. The class will use this key when [VerifySignature](#verifysignature-method-ecc-class) 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-class) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

**ConcatHashAlgorithm**: The hash algorithm to use when ComputeSecretKDF is Concat.This setting optionally specifies the hash algorithm to use when [ComputeSecretKDF](#computesecretkdf-property-ecc-class) 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-class) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

**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-class) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

**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-class) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

**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-class) is set to *ekdConcat*. This setting is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

**ECDSASignatureFormat**: The format of the HashSignature when using ECDSA keys.This setting specifies the format of [HashSignature](#hashsignature-property-ecc-class) when signing with ECDSA keys. The way the [HashSignature](#hashsignature-property-ecc-class) 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 [Algorithm](#ECCKey_f_Algorithm) 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 [Algorithm](#ECCKey_f_Algorithm) is set to *Ed25519* or *Ed448*. When this setting is specified, the [Algorithm](#ECCKey_f_Algorithm) is *Ed25519*, and [HashEdDSA](#hasheddsa-property-ecc-class) is *False*, the class will automatically use *Ed25519ctx*.

If this value is specified before calling [Sign](#sign-method-ecc-class), it must also be set prior to calling [VerifySignature](#verifysignature-method-ecc-class).

**EncryptionKeySize**: The encryption key size.This setting specifies the AES encryption key size in bits when [EncryptionAlgorithm](#encryptionalgorithm-property-ecc-class) is set to AES. Possible values are:

- 128
- 192
- 256 (default)

 This setting is only applicable when calling [Encrypt](#encrypt-method-ecc-class).

**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-class).

**HMACKeySize**: The HMAC key size to be used during encryption.This setting optionally specifies the HMAC key size to be used during encryption and decryption. If set to *0* (default), the class will automatically select the key size based on the algorithm specified in [HMACAlgorithm](#hmacalgorithm-property-ecc-class).

This setting is only applicable when calling [Encrypt](#encrypt-method-ecc-class) or [Decrypt](#decrypt-method-ecc-class).

**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-class) 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-class) and [Decrypt](#decrypt-method-ecc-class).

**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-class) 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-class) and [Decrypt](#decrypt-method-ecc-class).

**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-class).

Note: This is not applicable when [ComputeSecretKDF](#computesecretkdf-property-ecc-class) 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-class) is set to Raw. This value will be set after calling [ComputeSecret](#computesecret-method-ecc-class)

**StrictKeyValidation**: Whether to validate provided public keys based on private keys.This setting performs additional checks prior to using specified keys to validate that the public key corresponds to the provided private key.

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

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

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

**TLSLabel**: The TLS PRF label.This setting specifies a string representing the PRF label. This setting is required when [ComputeSecretKDF](#computesecretkdf-property-ecc-class) set to 12 (ekdTLS). It is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

**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-class) set to 12 (ekdTLS). It is only applicable when calling [ComputeSecret](#computesecret-method-ecc-class).

### Base Config Settings

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

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

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

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

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

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

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: [https://github.com/openssl/openssl/blob/master/README-FIPS.md](https://github.com/openssl/openssl/blob/master/README-FIPS.md)

To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([ECC](#ecc-class) Class)

## Error Handling (C++)

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

### ECC Errors

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