# JWE Class

Create, Encrypt and Decrypt JSON Web Encryption (JWE) messages.

## Syntax

**ipworksencrypt.jwe()**

## Remarks

The JWE class supports encrypting and decrypting JSON Web Encryption (JWE) messages.

Specify any payload via input properties and use [Encrypt](#jweencrypt-method) to create a JWE message using a variety of algorithms including ECDH, RSA, and AES. Use [Decrypt](#jwedecrypt-method) to decrypt the payload of any received JWE message. The following algorithms are supported:

- RSA1_5
- RSA-OAEP
- RSA-OAEP-256
- A128KW
- A192KW
- A256KW
- Direct
- ECDH-ES
- ECDH-ES+A128KW
- ECDH-ES+A192KW
- ECDH-ES+A256KW
- A128GCMKW
- A192GCMKW
- A256GCMKW
- PBES2-HS256+A128KW
- PBES2-HS384+A192KW
- PBES2-HS512+A256KW

See [EncryptionAlgorithm](#jweencryptionalgorithm-property) for more details about supported algorithms.

## Encrypting

The [Encrypt](#jweencrypt-method) method may be used to encrypt a payload with a variety of algorithms. JSON Web Encryption (JWE) is performed by first generating a random key used to encrypt the content. The content encryption key is used to encrypt the content using the algorithm specified by [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#jweencryptionalgorithm-property). The content encryption key is not directly exposed in the API as it is randomly generated.

After calling this method the compact serialized JWE string is written to the specified output location. For instance:

*eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A*

The class is agnostic of the payload that is encrypted. Any value may be encrypted. [KeyId](#jwekeyid-property) may be set to include an identifier to help the receiving party identify the key or certificate used to encrypt the data. The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#jweencryptionalgorithm-property) (required)
- [Key](#jwekey-property) (conditional - required for AES)
- [KeyPassword](#jwekeypassword-property) (conditional - required for PBES)
- [Certificate](#jwecertificate-property) (conditional - required for ECDH and RSA)
- [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property)
- [CompressionAlgorithm](#CompressionAlgorithm)
- [HeaderParams](#jweheaderparams-property)
- [Overwrite](#jweoverwrite-property)

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

When [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to a AES algorithm [Key](#jwekey-property) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.

The example below uses the [EzRand](EzRand.md#EzRand) class to generate a key, but the key may be created using any method. The key must be known by both parties in order for encryption and decryption to take place.

```csharp
//Generate a 256 bit (32 byte) key
Ezrand rand = new Ezrand();
rand.RandBytesLength = 32;
rand.GetNextBytes();
byte[] key = rand.RandBytesB;

//Encrypt the payload using A256KW
Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

To use an existing AES key provide the bytes to the [Key](#jwekey-property) property. For instance:

```csharp
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };

//Encrypt the payload using A256KW
Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)**

The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The public certificate should be in PEM (base64) format. For instance:

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate("..\\recipient.cer");
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaRSA_OAEP;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)**

ECDH algorithms require a valid ECC public key to encrypt the message. If the key was originally created with the ECC class the PEM encoded *PublicKey* may be used directly with the [Certificate](#jwecertificate-property) property. An example PEM encoded public certificate created by the ECC component:

```text
-----BEGIN PUBLIC KEY-----
MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA
AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG
NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt
6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA
//////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY
x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA==
-----END PUBLIC KEY-----
```

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*");
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

To use an ECC public key created by other means the ECC class may be used to import the key parameters. Populate the *Rx* and *Ry* properties of the ECC component first to obtain the PEM formatted public key. For instance:

```csharp
byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };

Ecc ecc = new Ecc();
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;

string pubKey = ecc.Key.PublicKey;

Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW**

PBES algorithms derive a content encryption key from the [KeyPassword](#jwekeypassword-property) property. Set [KeyPassword](#jwekeypassword-property) to a shared secret.

```csharp
Jwe jwe = new Jwe();
jwe.KeyPassword = "secret";
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaPBES2_HS512_A256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for Direct Shared Keys**

When [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to *Direct* the [Key](#jwekey-property) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). In this case a content encryption key is not generated randomly, the [Key](#jwekey-property) is used instead. The length of the specified [Key](#jwekey-property) must be valid for the selected [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). For instance:

```csharp
//Generate a 256 bit (32 byte) key
Ezrand rand = new Ezrand();
rand.RandBytesLength = 32;
rand.GetNextBytes();

byte[] key = rand.RandBytesB;

Jwe jwe = new Jwe();
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaDir;
jwe.ContentEncryptionAlgorithm = JweContentEncryptionAlgorithms.ceaA256GCM;
jwe.KeyB = key;
jwe.InputMessage = "test data";
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

## Decrypting

The [Decrypt](#jwedecrypt-method) method may be used to decrypt a received JWE message. Before calling the [Decrypt](#jwedecrypt-method) method set [InputMessage](#jweinputmessage-property) or [InputFile](#jweinputfile-property) to a valid compact serialized JWE string. For instance:

*eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A*

The type and format of the private key depends on the algorithm used to encrypt the data. The following table summarizes the relationship:

|  |  |
| --- | --- |
| Algorithm | Private Key Location |
| AES | [Key](#jwekey-property) |
| RSA and ECDH | [Certificate](#jwecertificate-property) |
| PBES | [KeyPassword](#jwekeypassword-property) |

 If the correct [Key](#jwekey-property) or [Certificate](#jwecertificate-property) is not known ahead of time the *KeyId* parameter of the [RecipientInfo](#jwerecipientinfo-event) event may be used to identify the correct key.

If this method returns without error decryption was successful. If decryption fails then this method . After calling this method the payload will be present in the [OutputMessage](#jweoutputmessage-property) or file specified by [OutputFile](#jweoutputfile-property) and the [HeaderParams](#jweheaderparams-property) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#jweheaderparam-event) event.

The following properties are applicable when calling this method:

- [Certificate](#jwecertificate-property) (conditional - required for RSA and ECDH)
- [Key](#jwekey-property) (conditional - required for AES)
- [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property) (only if [StrictValidation](#StrictValidation) is True)
- [EncryptionAlgorithm](#jweencryptionalgorithm-property) (only if [StrictValidation](#StrictValidation) is True)
- [HeaderParams](#jweheaderparams-property)
- [Overwrite](#jweoverwrite-property)
- [StrictValidation](#StrictValidation)

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

To decrypt messages that use AES encryption [Key](#jwekey-property) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.

The key must be known by both parties in order for encryption and decryption to take place.

```csharp
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };

Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)**

The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The certificate with private key must be specified. For instance:

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*");
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)**

ECDH algorithms require a valid ECC private key to decrypt the message. If the key was originally created with the ECC class the PEM encoded *PrivateKey* may be used directly with the [Certificate](#jwecertificate-property) property.

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*");
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

To use an ECC private key created by other means the ECC class may be used to import the key parameters. Populate the *Rx*, *Ry*, and *KB* properties of the ECC component first to obtain the PEM formatted public key. For instance:

```csharp
Ecc ecc = new Ecc();

byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 };

ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
ecc.Key.KB = k_bytes;

string privKey = ecc.Key.PrivateKey;

Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW**

PBES algorithms derive a content encryption key from the [KeyPassword](#jwekeypassword-property) property. Set [KeyPassword](#jwekeypassword-property) to the shared secret.

```csharp
Jwe jwe = new Jwe();
jwe.KeyPassword = "secret";
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for Direct Shared Keys**

When Direct encryption is used the [Key](#jwekey-property) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). For instance:

```csharp
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };

Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

## Other Functionality

In addition to standard encrypting and decrypting the class also supports a variety of other features including:

- Adding custom header parameters with [AddHeaderParam](#jweaddheaderparam-method)
- Enforcing algorithm restrictions when decrypting by setting [StrictValidation](#StrictValidation)
- Inspect the JWE headers without decrypting by calling [Parse](#jweparse-method)

## 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](#jwecertificate-property) | The certificate used for encryption or decryption. |
| [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property) | The algorithm used to encrypt the content. |
| [EncryptionAlgorithm](#jweencryptionalgorithm-property) | The key encryption algorithm. |
| [HeaderParams](#jweheaderparams-property) | The JOSE header parameters. |
| [InputFile](#jweinputfile-property) | The file to process. |
| [InputMessage](#jweinputmessage-property) | The message to process. |
| [Key](#jwekey-property) | The secret key for the AES algorithm. |
| [KeyId](#jwekeyid-property) | The Id of the key used to encrypt the message. |
| [KeyPassword](#jwekeypassword-property) | The key password used in the PBES algorithm. |
| [OutputFile](#jweoutputfile-property) | The output file when encrypting or decrypting. |
| [OutputMessage](#jweoutputmessage-property) | The output message after processing. |
| [Overwrite](#jweoverwrite-property) | Indicates whether or not the class should overwrite files. |

## Method List

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

|  |  |
| --- | --- |
| [AddHeaderParam](#jweaddheaderparam-method) | Adds additional header parameters. |
| [Config](#jweconfig-method) | Sets or retrieves a configuration setting. |
| [Decrypt](#jwedecrypt-method) | Decrypts the payload. |
| [Encrypt](#jweencrypt-method) | Encrypts the payload with the specified algorithms. |
| [Parse](#jweparse-method) | Parses the compact serialized JWE string. |
| [Reset](#jwereset-method) | Resets the class. |
| [SetInputStream](#jwesetinputstream-method) | Sets the stream from which the class will read data. |
| [SetOutputStream](#jwesetoutputstream-method) | Sets the stream to which the class will write 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](#jweerror-event) | Fired when information is available about errors during data delivery. |
| [HeaderParam](#jweheaderparam-event) | Fires once for each JOSE header parameter. |
| [RecipientInfo](#jwerecipientinfo-event) | Fired with information about the recipient key of the encrypted message. |

## Config Settings

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

|  |  |
| --- | --- |
| [CompressionAlgorithm](#CompressionAlgorithm) | The compression algorithm to use. |
| [PartyUInfo](#PartyUInfo) | Information about the producer of the message. |
| [PartyVInfo](#PartyVInfo) | Information about the recipient of the message. |
| [PBES2Count](#PBES2Count) | The PBKDF2 iteration count. |
| [PBES2SaltLength](#PBES2SaltLength) | The salt input value length. |
| [RawHeader](#RawHeader) | Holds the raw JOSE header. |
| [StrictValidation](#StrictValidation) | Requires specific algorithm when decrypting. |
| [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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [JWE](#jwe-class).Certificate Property

The certificate used for encryption or decryption.

## Syntax

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

## Default Value

## Remarks

This property specifies a certificate for encryption or decryption.

When calling [Encrypt](#jweencrypt-method) and [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to an RSA or ECDH algorithm this property must be set to a public certificate of the recipient.

When calling [Decrypt](#jwedecrypt-method) and the message was encrypted using an RSA or ECDH [EncryptionAlgorithm](#jweencryptionalgorithm-property) this property specifies the certificate with private key used to decrypt the message.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [JWE](#jwe-class).ContentEncryptionAlgorithm Property

The algorithm used to encrypt the content.

## Syntax

```text
getContentEncryptionAlgorithm(): JWEContentEncryptionAlgorithms;
setContentEncryptionAlgorithm(contentEncryptionAlgorithm: JWEContentEncryptionAlgorithms): void;
enum JWEContentEncryptionAlgorithms {
  ceaA128CBC_HS256,
  ceaA192CBC_HS384,
  ceaA256CBC_HS512,
  ceaA128GCM,
  ceaA192GCM,
  ceaA256GCM
}
```

## Default Value

0

## Remarks

This property specifies the algorithm used to encrypt the content.

The following values are supported.

| Algorithm | Description |
| --- | --- |
| 0 (ceaA128CBC_HS256 - default) | AES_128_CBC_HMAC_SHA_256 authenticated encryption algorithm |
| 1 (ceaA192CBC_HS384) | AES_192_CBC_HMAC_SHA_384 authenticated encryption algorithm |
| 2 (ceaA256CBC_HS512) | AES_256_CBC_HMAC_SHA_512 authenticated encryption algorithm |
| 3 (ceaA128GCM) | AES GCM using 128-bit key |
| 4 (ceaA192GCM) | AES GCM using 192-bit key |
| 5 (ceaA256GCM) | AES GCM using 256-bit key |

# [JWE](#jwe-class).EncryptionAlgorithm Property

The key encryption algorithm.

## Syntax

```text
getEncryptionAlgorithm(): JWEEncryptionAlgorithms;
setEncryptionAlgorithm(encryptionAlgorithm: JWEEncryptionAlgorithms): void;
enum JWEEncryptionAlgorithms {
  eaRSA1_5,
  eaRSA_OAEP,
  eaRSA_OAEP_256,
  eaA128KW,
  eaA192KW,
  eaA256KW,
  eaDir,
  eaECDH_ES,
  eaECDH_ES_A128KW,
  eaECDH_ES_A192KW,
  eaECDH_ES_A256KW,
  eaA128GCMKW,
  eaA192GCMKW,
  eaA256GCMKW,
  eaPBES2_HS256_A128KW,
  eaPBES2_HS384_A192KW,
  eaPBES2_HS512_A256KW
}
```

## Default Value

0

## Remarks

This property specifies the algorithm used to encrypt the randomly generated content encryption key.

When using an AES algorithm [Key](#jwekey-property) must be specified. When using an RSA or ECDH algorithm [Certificate](#jwecertificate-property) must be specified. When using a PBES algorithm [KeyPassword](#jwekeypassword-property) must be specified;. Possible values are:

| Algorithm | Description | Key Location |
| --- | --- | --- |
| 0 (eaRSA1_5 - default) | RSAES-PKCS1-v1_5 | [Certificate](#jwecertificate-property) |
| 1 (eaRSA_OAEP) | RSAES OAEP using default parameters | [Certificate](#jwecertificate-property) |
| 2 (eaRSA_OAEP_256) | RSAES OAEP using SHA-256 and MGF1 with SHA-256 | [Certificate](#jwecertificate-property) |
| 3 (eaA128KW) | AES Key Wrap with default initial using 128-bit key | [Key](#jwekey-property) |
| 4 (eaA192KW) | AES Key Wrap with default initial using 192-bit key | [Key](#jwekey-property) |
| 5 (eaA256KW) | AES Key Wrap with default initial using 256-bit key | [Key](#jwekey-property) |
| 6 (eaDir) | Direct use of a shared symmetric key as the CEK | [Key](#jwekey-property) |
| 7 (eaECDH_ES) | Elliptic Curve Ephemeral Static key agreement using Concat KDF | [Certificate](#jwecertificate-property) |
| 8 (eaECDH_ES_A128KW) | ECDH-ES using Concat KDF and CEK wrapped with A128KW | [Certificate](#jwecertificate-property) |
| 9 (eaECDH_ES_A192KW) | ECDH-ES using Concat KDF and CEK wrapped with A192KW | [Certificate](#jwecertificate-property) |
| 10 (eaECDH_ES_A256KW) | ECDH-ES using Concat KDF and CEK wrapped with A256KW | [Certificate](#jwecertificate-property) |
| 11 (eaA128GCMKW) | Key wrapping with AES GCM using 128-bit key | [Key](#jwekey-property) |
| 12 (eaA192GCMKW) | Key wrapping with AES GCM using 192-bit key | [Key](#jwekey-property) |
| 13 (eaA256GCMKW) | Key wrapping with AES GCM using 256-bit key | [Key](#jwekey-property) |
| 14 (eaPBES2_HS256_A128KW) | PBES2 with HMAC SHA-256 and A128KW | [KeyPassword](#jwekeypassword-property) |
| 15 (eaPBES2_HS384_A192KW) | PBES2 with HMAC SHA-384 and A192KW | [KeyPassword](#jwekeypassword-property) |
| 16 (eaPBES2_HS512_A256KW) | PBES2 with HMAC SHA-512 and A256KW | [KeyPassword](#jwekeypassword-property) |

When set to an ECDH algorithm the following settings are also applicable:

- [PartyUInfo](#PartyUInfo)
- [PartyVInfo](#PartyVInfo)

When set to a PBES algorithm the following settings are also applicable:

- [PBES2Count](#PBES2Count)
- [PBES2SaltLength](#PBES2SaltLength)

# [JWE](#jwe-class).HeaderParams Property

The JOSE header parameters.

## Syntax

```text
getHeaderParams(): HeaderParamList;
```

## Default Value

## Remarks

This property specifies the JOSE header parameters. This may be populated before calling Sign or [Encrypt](#jweencrypt-method). This is populated with the parsed header values after calling Verify, [Decrypt](#jwedecrypt-method), or [Parse](#jweparse-method).

This property is not available at design time.

 Please refer to the [HeaderParam](#headerparam-type) type for a complete list of fields.

# [JWE](#jwe-class).InputFile Property

The file to process.

## Syntax

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

## Default Value

""

## Remarks

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

**Input and Output Properties**

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

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

- InputFile
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

# [JWE](#jwe-class).InputMessage Property

The message to process.

## Syntax

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

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input and Output Properties**

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

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

- [InputFile](#jweinputfile-property)
- InputMessage

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

# [JWE](#jwe-class).Key Property

The secret key for the AES algorithm.

## Syntax

```text
getKey(): Uint8Array;
setKey(key: Uint8Array): void;
```

## Default Value

""

## Remarks

This property specifies the key used for AES encryption and decryption.

When [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to an AES algorithm this property must hold the symmetric key used for encryption and decryption. The size of the key must match the size of the algorithm. For instance when selecting the algorithm *A256GCMKW* (AES 256) the size of the key must also be 256 bits (32 bytes).

In the case where [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to *Direct* this key is used directly with the algorithm specified by [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property) and must be an appropriate size for the selected [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property).

# [JWE](#jwe-class).KeyId Property

The Id of the key used to encrypt the message.

## Syntax

```text
getKeyId(): string;
setKeyId(keyId: string): void;
```

## Default Value

""

## Remarks

This property optionally specifies the Id of the key used to encrypt the message.

Any string value may be supplied here to help the other party identify the key used to encrypt the message. This may be set before calling the [Encrypt](#jweencrypt-method) method.

# [JWE](#jwe-class).KeyPassword Property

The key password used in the PBES algorithm.

## Syntax

```text
getKeyPassword(): string;
setKeyPassword(keyPassword: string): void;
```

## Default Value

""

## Remarks

This property specifies the key password used to derive a key when using a PBES [EncryptionAlgorithm](#jweencryptionalgorithm-property).

This is only applicable to PBES algorithms and must be set before calling [Encrypt](#jweencrypt-method) or [Decrypt](#jwedecrypt-method).

# [JWE](#jwe-class).OutputFile Property

The output file when encrypting or decrypting.

## Syntax

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

## Default Value

""

## Remarks

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

This property is only applicable to [Encrypt](#jweencrypt-method) and [Decrypt](#jwedecrypt-method).

**Input and Output Properties**

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

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- OutputFile
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

# [JWE](#jwe-class).OutputMessage Property

The output message after processing.

## Syntax

```text
getOutputMessage(): Uint8Array;
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [OutputFile](#jweoutputfile-property) is not set.

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- OutputMessage: The output data is written to this property if no other destination is specified.

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

# [JWE](#jwe-class).Overwrite Property

Indicates whether or not the class should overwrite files.

## Syntax

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

## Default Value

FALSE

## Remarks

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

# [JWE](#jwe-class).addHeaderParam Method

Adds additional header parameters.

## Syntax

```text
async jwe.addHeaderParam(name : string, value : string, dataType : number): Promise< void>
```

## Remarks

This method is used to add additional header parameters before calling [Encrypt](#jweencrypt-method).

The *Name* and *Value* parameters define the name and value of the parameter respectively. The *DataType* parameter specifies the JSON data type of the value. Possible values for *DataType* are:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)

 To add additional parameters to the JOSE header use this method. For instance to create this header:

```text
{
	"alg": "A256GCMKW",
	"crit": [
		"exp"
	],
	"enc": "A128CBC-HS256",
	"exp": 12345687,
	"iv": "SFZ9o0KKN8qF8yod",
	"tag": "tREHGKuViLo7s3QpRTulkg",
	"type": "JWT"
}
```

The following code can be used:

```csharp
Jwe jwe = new Jwe();
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256GCMKW;
jwe.KeyB = key;
jwe.AddHeaderParam("type", "JWT", 2);
jwe.AddHeaderParam("crit", "[\"exp\"]", 1);
jwe.AddHeaderParam("exp", "12345687", 3);
jwe.InputMessage = "test";
jwe.Encrypt();
string encryptedData = jwe.OutputMessage;
```

Note: When calling [Encrypt](#jweencrypt-method) the class will automatically add headers based on the selected [EncryptionAlgorithm](#jweencryptionalgorithm-property) and other properties that may be set.

**Parameters Automatically Set:**

| Header Param | Property |
| --- | --- |
| alg | [EncryptionAlgorithm](#jweencryptionalgorithm-property) |
| enc | [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property) |
| kid | [KeyId](#jwekeyid-property) |
| zip | [CompressionAlgorithm](#CompressionAlgorithm) |
| p2c | [PBES2Count](#PBES2Count) (PBES Algorithms Only) |
| apu | [PartyUInfo](#PartyUInfo) (ECDH Algorithms Only) |
| apv | [PartyVInfo](#PartyVInfo) (ECDH Algorithms Only) |
| iv | N/A - Automatically Generated (AES Algorithms Only) |
| tag | N/A - Automatically Generated (AES Algorithms Only) |
| p2s | N/A - Automatically Generated (PBES Algorithms Only) |
| epk | N/A - Automatically Generated (ECDH Algorithms Only) |

# [JWE](#jwe-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async jwe.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworksencryptjwe) 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-class-ipworksencryptjwe), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [JWE](#jwe-class).decrypt Method

Decrypts the payload.

## Syntax

```text
async jwe.decrypt(): Promise< void>
```

## Remarks

This method decrypts the input data.

Before calling the Decrypt method set [InputMessage](#jweinputmessage-property) or [InputFile](#jweinputfile-property) to a valid compact serialized JWE string. For instance:

*eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A*

The type and format of the private key depends on the algorithm used to encrypt the data. The following table summarizes the relationship:

|  |  |
| --- | --- |
| Algorithm | Private Key Location |
| AES | [Key](#jwekey-property) |
| RSA and ECDH | [Certificate](#jwecertificate-property) |
| PBES | [KeyPassword](#jwekeypassword-property) |

 If the correct [Key](#jwekey-property) or [Certificate](#jwecertificate-property) is not known ahead of time the *KeyId* parameter of the [RecipientInfo](#jwerecipientinfo-event) event may be used to identify the correct key.

If this method returns without error decryption was successful. If decryption fails then this method . After calling this method the payload will be present in the [OutputMessage](#jweoutputmessage-property) or file specified by [OutputFile](#jweoutputfile-property) and the [HeaderParams](#jweheaderparams-property) property will contain the headers. Headers of the parsed message are also available through the [HeaderParam](#jweheaderparam-event) event.

The following properties are applicable when calling this method:

- [Certificate](#jwecertificate-property) (conditional - required for RSA and ECDH)
- [Key](#jwekey-property) (conditional - required for AES)
- [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property) (only if [StrictValidation](#StrictValidation) is True)
- [EncryptionAlgorithm](#jweencryptionalgorithm-property) (only if [StrictValidation](#StrictValidation) is True)
- [HeaderParams](#jweheaderparams-property)
- [Overwrite](#jweoverwrite-property)
- [StrictValidation](#StrictValidation)

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

To decrypt messages that use AES encryption [Key](#jwekey-property) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.

The key must be known by both parties in order for encryption and decryption to take place.

```csharp
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };

Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)**

The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The certificate with private key must be specified. For instance:

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "..\\jwt.pfx", "password", "*");
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)**

ECDH algorithms require a valid ECC private key to decrypt the message. If the key was originally created with the ECC class the PEM encoded *PrivateKey* may be used directly with the [Certificate](#jwecertificate-property) property.

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyFile, privKeyFile, "", "*");
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

To use an ECC private key created by other means the ECC class may be used to import the key parameters. Populate the *Rx*, *Ry*, and *KB* properties of the ECC component first to obtain the PEM formatted public key. For instance:

```csharp
Ecc ecc = new Ecc();

byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };
byte[] k_bytes = new byte[] { 81, 65, 201, 24, 235, 249, 162, 148, 169, 150, 109, 181, 61, 238, 145, 122, 31, 30, 151, 94, 239, 90, 222, 217, 63, 103, 54, 2, 176, 232, 248, 168 };

ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;
ecc.Key.KB = k_bytes;

string privKey = ecc.Key.PrivateKey;

Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPEMKeyBlob, privKey, "", "*");
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW**

PBES algorithms derive a content encryption key from the [KeyPassword](#jwekeypassword-property) property. Set [KeyPassword](#jwekeypassword-property) to the shared secret.

```csharp
Jwe jwe = new Jwe();
jwe.KeyPassword = "secret";
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

**Notes for Direct Shared Keys**

When Direct encryption is used the [Key](#jwekey-property) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). For instance:

```csharp
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };

Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = encryptedData;
jwe.Decrypt();

string decryptedData = jwe.OutputMessage;
```

# [JWE](#jwe-class).encrypt Method

Encrypts the payload with the specified algorithms.

## Syntax

```text
async jwe.encrypt(): Promise< void>
```

## Remarks

This method encrypts the input data using the specified algorithms.

JSON Web Encryption (JWE) is performed by first generating a random key used to encrypt the content. The content encryption key is used to encrypt the content using the algorithm specified by [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#jweencryptionalgorithm-property). The content encryption key is not directly exposed in the API as it is randomly generated.

After calling this method the compact serialized JWE string is written to the specified output location. For instance:

*eyJhbGciOiJBMjU2R0NNS1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiaXYiOiJMa0tNeTZ5Qlpfbzh6QW92IiwidGFnIjoiSmpMTkRsV3l3bWt3V2pMa0NLU0xxQSJ9.wiwySYm6fXZre-3IdT1tb_02KMQDrMICwUawVf7Gjhc.k84s7ne8J41QnA5BQ31k_A.kjIveRjjNYV4x92CVE9Agw.uAygkyeO2KWeFQIy9JLU0A*

The class is agnostic of the payload that is encrypted. Any value may be encrypted. [KeyId](#jwekeyid-property) may be set to include an identifier to help the receiving party identify the key or certificate used to encrypt the data. The following properties are applicable when calling this method:

- [EncryptionAlgorithm](#jweencryptionalgorithm-property) (required)
- [Key](#jwekey-property) (conditional - required for AES)
- [KeyPassword](#jwekeypassword-property) (conditional - required for PBES)
- [Certificate](#jwecertificate-property) (conditional - required for ECDH and RSA)
- [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property)
- [CompressionAlgorithm](#CompressionAlgorithm)
- [HeaderParams](#jweheaderparams-property)
- [Overwrite](#jweoverwrite-property)

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

**Notes for AES Algorithms (A128KW, A192KW, A256KW, A128GCMKW, A192GCMKW, A256GCMKW)**

When [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to a AES algorithm [Key](#jwekey-property) must be set to a key of appropriate length for the algorithm. For instance a 256 bit key would be used for A256KW.

The example below uses the [EzRand](EzRand.md#EzRand) class to generate a key, but the key may be created using any method. The key must be known by both parties in order for encryption and decryption to take place.

```csharp
//Generate a 256 bit (32 byte) key
Ezrand rand = new Ezrand();
rand.RandBytesLength = 32;
rand.GetNextBytes();
byte[] key = rand.RandBytesB;

//Encrypt the payload using A256KW
Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

To use an existing AES key provide the bytes to the [Key](#jwekey-property) property. For instance:

```csharp
byte[] key = new byte[] { 164, 60, 194, 0, 161, 189, 41, 38, 130, 89, 141, 164, 45, 170, 159, 209, 69, 137, 243, 216, 191, 131, 47, 250, 32, 107, 231, 117, 37, 158, 225, 234 };

//Encrypt the payload using A256KW
Jwe jwe = new Jwe();
jwe.KeyB = key;
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaA256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for RSA Algorithms (RSA1_5, RSA-OEAP, RSA-OAEP-256)**

The RSA based algorithms use asymmetric encryption. Encrypting is done with a public key and decryption is done with a private key. The public certificate should be in PEM (base64) format. For instance:

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate("..\\recipient.cer");
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaRSA_OAEP;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for ECDH Algorithms (ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, ECDH-ES+A256KW)**

ECDH algorithms require a valid ECC public key to encrypt the message. If the key was originally created with the ECC class the PEM encoded *PublicKey* may be used directly with the [Certificate](#jwecertificate-property) property. An example PEM encoded public certificate created by the ECC component:

```text
-----BEGIN PUBLIC KEY-----
MIIBMjCB7AYHKoZIzj0CATCB4AIBATAsBgcqhkjOPQEBAiEA/////wAAAAEAAAAAAAAAAAAA
AAD///////////////8wRAQg/////wAAAAEAAAAAAAAAAAAAAAD///////////////wEIFrG
NdiqOpPns+u9VXaYhrxlHQawzFOw9jvOPD4n0mBLBEEEaxfR8uEsQkf4vOblY6RA8ncDfYEt
6zOg9KE5RdiYwpZP40Li/hp/m47n60p8D54WK84zV2sxXs7LtkBoN79R9QIhAP////8AAAAA
//////////+85vqtpxeehPO5ysL8YyVRAgEBA0EEIC5rbLp11Mnz6cBXLLriaDIov3rm8RAY
x/OR0bOKiff0cQy+sLVaxjseqFk/+Xvl4ORSv5Z6HdHv5GyEpA0UoA==
-----END PUBLIC KEY-----
```

```csharp
Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKeyFile, "", "*");
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

To use an ECC public key created by other means the ECC class may be used to import the key parameters. Populate the *Rx* and *Ry* properties of the ECC component first to obtain the PEM formatted public key. For instance:

```csharp
byte[] x_bytes = new byte[] { 171, 170, 196, 151, 94, 196, 231, 12, 128, 232, 17, 61, 45, 105, 41, 209, 192, 187, 112, 242, 110, 178, 95, 240, 36, 55, 83, 171, 190, 176, 78, 13 };
byte[] y_bytes = new byte[] { 197, 75, 134, 245, 245, 28, 199, 9, 7, 117, 1, 54, 49, 178, 135, 252, 62, 89, 35, 180, 117, 80, 231, 23, 110, 250, 28, 124, 219, 253, 224, 156 };

Ecc ecc = new Ecc();
ecc.Key.RxB = x_bytes;
ecc.Key.RyB = y_bytes;

string pubKey = ecc.Key.PublicKey;

Jwe jwe = new Jwe();
jwe.Certificate = new Certificate(CertStoreTypes.cstPublicKeyFile, pubKey, "", "*");
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaECDH_ES_A256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for PBES Algorithms (PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW**

PBES algorithms derive a content encryption key from the [KeyPassword](#jwekeypassword-property) property. Set [KeyPassword](#jwekeypassword-property) to a shared secret.

```csharp
Jwe jwe = new Jwe();
jwe.KeyPassword = "secret";
jwe.InputMessage = "test data";
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaPBES2_HS512_A256KW;
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

**Notes for Direct Shared Keys**

When [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to *Direct* the [Key](#jwekey-property) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). In this case a content encryption key is not generated randomly, the [Key](#jwekey-property) is used instead. The length of the specified [Key](#jwekey-property) must be valid for the selected [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). For instance:

```csharp
//Generate a 256 bit (32 byte) key
Ezrand rand = new Ezrand();
rand.RandBytesLength = 32;
rand.GetNextBytes();

byte[] key = rand.RandBytesB;

Jwe jwe = new Jwe();
jwe.EncryptionAlgorithm = JweEncryptionAlgorithms.eaDir;
jwe.ContentEncryptionAlgorithm = JweContentEncryptionAlgorithms.ceaA256GCM;
jwe.KeyB = key;
jwe.InputMessage = "test data";
jwe.Encrypt();

string encryptedData = jwe.OutputMessage;
```

# [JWE](#jwe-class).parse Method

Parses the compact serialized JWE string.

## Syntax

```text
async jwe.parse(): Promise< void>
```

## Remarks

This method parses, but does not decrypt, the JWE string.

Take care when using this method as no decryption is performed. This method may be helpful in cases where only header information is desired.

If decryption is desired, use [Decrypt](#jwedecrypt-method) instead. It is not necessary to call this method before calling [Decrypt](#jwedecrypt-method). [Decrypt](#jwedecrypt-method) will both parse and decrypt the message.

When calling this method the headers are parsed. The [HeaderParam](#jweheaderparam-event) and [RecipientInfo](#jwerecipientinfo-event) events will fire and the [HeaderParams](#jweheaderparams-property) property will be populated.

# [JWE](#jwe-class).reset Method

Resets the class.

## Syntax

```text
async jwe.reset(): Promise< void>
```

## Remarks

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

# [JWE](#jwe-class).setInputStream Method

Sets the stream from which the class will read data.

## Syntax

```text
async jwe.setInputStream(inputStream : ReadableStream): Promise< void>
```

## Remarks

This method may be used to set a stream from which data will be read.

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

# [JWE](#jwe-class).setOutputStream Method

Sets the stream to which the class will write data.

## Syntax

```text
async jwe.setOutputStream(outputStream : WriteableStream): Promise< void>
```

## Remarks

This method may be used to specify a stream to which data will be written.

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

- [InputFile](#jweinputfile-property)
- [InputMessage](#jweinputmessage-property)

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

- [OutputFile](#jweoutputfile-property)
- [OutputMessage](#jweoutputmessage-property): The output data is written to this property if no other destination is specified.

# [JWE](#jwe-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

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

## Remarks

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

The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-ipworksencryptjwe) section.

# [JWE](#jwe-class).HeaderParam Event

Fires once for each JOSE header parameter.

## Syntax

```text
jwe.on('HeaderParam', listener: (e: {readonly name: string, readonly value: string, readonly dataType: number}) => void )
```

## Remarks

When [Decrypt](#jwedecrypt-method) or [Parse](#jweparse-method) is called this event will fire once for each JOSE header parameter.

*Name* is the name of the parameter.

*Value* is the value of the parameter.

*DataType* specifies the JSON data type of the value. Possible values are:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)

# [JWE](#jwe-class).RecipientInfo Event

Fired with information about the recipient key of the encrypted message.

## Syntax

```text
jwe.on('RecipientInfo', listener: (e: {readonly keyId: string, readonly algorithm: string}) => void )
```

## Remarks

This event fires with information about the key used to encrypt the data. This may be used to help identify the [Key](#jwekey-property) or [Certificate](#jwecertificate-property) to load in order to decrypt the message. This event fires when [Decrypt](#jwedecrypt-method) or [Parse](#jweparse-method) is called.

*KeyId* is the Id of the key as supplied by the entity that created the message. This may be empty.

*Algorithm* is the encryption algorithm used to encrypt the data.

# Certificate Type

This is the digital certificate being used.

## Remarks

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

The following fields are available:

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

- [KeyPassword](#Certificate_f_KeyPassword)

- [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** *string (read-only)*
*Default Value: ""*

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

23-Jan-2000 15:00:00.

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

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

23-Jan-2001 15:00:00.

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

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

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

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

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

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

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

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

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

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

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

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

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

 **KeyPassword** *string*
*Default Value: ""*

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

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

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

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

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

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

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

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

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

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

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

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

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

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

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

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

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

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

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

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

 **Store** *string*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

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

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

 Designations of certificate stores are platform dependent.

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

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

 **StoreB** *Uint8Array*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

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

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| 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** *string*
*Default Value: ""*

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

 **StoreType** *CertStoreTypes*
*Default Value: 0*

The type of certificate store for this certificate.

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

```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 [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#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 [](#f_Store) and set [](#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** *string (read-only)*
*Default Value: ""*

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

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

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

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

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

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

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

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

The text description of .

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

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

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

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

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

|  |  |
| --- | --- |
| 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  property for a text representation of .

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

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

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

 **Subject** *string*
*Default Value: ""*

The subject of the certificate used for client authentication.

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

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

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

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

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

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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** *string*
*Default Value: ""*

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

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

 **EncodedB** *Uint8Array*
*Default Value: ""*

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

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

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

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

```text
public Certificate(byte[] encoded);
```

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# HeaderParam Type

The JOSE header parameter.

## Remarks

This type holds the JOSE header parameters. The fields define the name, value, and data type of the parameter.

The following fields are available:

- [DataType](#HeaderParam_f_DataType)

- [Name](#HeaderParam_f_Name)

- [Value](#HeaderParam_f_Value)

## Fields

 **DataType** *TDataTypes*
*Default Value: 2*

The data type of the header parameter.

This property specifies the JSON type of the header parameter value. Possible values are:

- 0 (Object)
- 1 (Array)
- 2 (String)
- 3 (Number)
- 4 (Bool)
- 5 (Null)

 **Name** *string*
*Default Value: ""*

The header parameter name.

 **Value** *string*
*Default Value: ""*

The header parameter value.

## Constructors

```text
public HeaderParam();
```

 Creates a new header parameter with no name or value.

```text
public HeaderParam(String name, String value);
```

 Creates a new header parameter. The DataType of the value will be a String.

```text
public HeaderParam(String name, String value, int dataType);
```

 Creates a new header parameter with the specified DataType.

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The JWE class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the JWE class.

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

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The JWE class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the JWE class.

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

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *ipworksencrypt.[jwe](#jwe-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](#jweconfig-method) method.

### JWE Config Settings

**CompressionAlgorithm**: The compression algorithm to use.This setting specifies the compression algorithm to use (if any). If set the content will be compressed using the specified algorithm. Possible values are:

- 0 (none - default)
- 1 (deflate)

**PartyUInfo**: Information about the producer of the message.This setting may optionally be set when Algorithm is set to an ECDH algorithm before calling [Encrypt](#jweencrypt-method). When calling [Decrypt](#jwedecrypt-method) this setting is populated and also accessible from within the [RecipientInfo](#jwerecipientinfo-event) event. The value may be any string. To specify a base64url encoded value directly prefix the string with *[b64]*. For instance the following lines both set the same value:

```csharp
jwe.Config("PartyUInfo=Alice");
jwe.Config("PartyUInfo=[b64]QWxpY2U="); //Equivalent to above line
```

**PartyVInfo**: Information about the recipient of the message.This setting may optionally be set when Algorithm is set to an ECDH algorithm before calling [Encrypt](#jweencrypt-method). When calling [Decrypt](#jwedecrypt-method) this setting is populated and also accessible from within the [RecipientInfo](#jwerecipientinfo-event) event. The value may be any string. To specify a base64url encoded value directly prefix the string with *[b64]*. For instance the following lines both set the same value:

```csharp
jwe.Config("PartyUInfo=Bob");
jwe.Config("PartyUInfo=[b64]Qm9i"); //Equivalent to above line
```

**PBES2Count**: The PBKDF2 iteration count.This setting specifies the PBDKF2 iteration count. A minimum value of *1000* is recommended. The default value is *1000*.

This setting is only applicable when [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to a PBES algorithm.

**PBES2SaltLength**: The salt input value length.This setting specifies the length in bytes of the salt input value, which is used as part of the PBKDF2 salt value. The default value is *16*.

This setting is only applicable when [EncryptionAlgorithm](#jweencryptionalgorithm-property) is set to a PBES algorithm.

**RawHeader**: Holds the raw JOSE header.This setting may be queried after calling [Encrypt](#jweencrypt-method) or [Decrypt](#jwedecrypt-method) to obtain the raw JOSE header. This returns a JSON string like:

*{"alg":"A128GCMKW","enc":"A256CBC-HS512","iv":"oSqGqGiA48O1uD9b","tag":"0WNBx27Z5aL5uvsd01d1Tw"}*

**StrictValidation**: Requires specific algorithm when decrypting.If set to True the class will validate the that algorithms used in the JWE message match the values specified in [EncryptionAlgorithm](#jweencryptionalgorithm-property) and [ContentEncryptionAlgorithm](#jwecontentencryptionalgorithm-property). If either algorithms do not match the class .

By default this setting is False and the algorithms are read automatically from the encrypted JWE message.

### 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*.

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

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

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

# Trappable Errors (*class *ipworksencrypt.[jwe](#jwe-class))

### JWE Errors

|  |  |
| --- | --- |
| 101 | Invalid JWE message. See message for details. |
| 102 | Unsupported compression algorithm. |
| 103 | Unsupported content encryption algorithm. |
| 104 | Unsupported key encryption algorithm. |
| 105 | A required header for decryption was not found. See message for details. |
| 106 | The specified key is not a valid length for the algorithm. |
| 107 | OutputFile already exists and Overwrite is False. |
| 108 | KeyPassword must be set for the selected algorithm. |
| 109 | Key must be set for the selected algorithm. |
| 110 | Certificate must be set for the selected algorithm. |
| 111 | A header parameter defined to be critical is not present. |
| 112 | Error writing data. |
| 113 | Error reading data. Check message for details. |
| 114 | Error encrypting. Check message for details. |
| 115 | Error decrypting. Check message for details. |