# JWE Class

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

## Class Name

**IPWorksEncrypt_JWE**

## Procedural Interface

```text
 ipworksencrypt_jwe_open();
 ipworksencrypt_jwe_close($res);
 ipworksencrypt_jwe_register_callback($res, $id, $function);
 ipworksencrypt_jwe_get_last_error($res);
 ipworksencrypt_jwe_get_last_error_code($res);
 ipworksencrypt_jwe_set($res, $id, $index, $value);
 ipworksencrypt_jwe_get($res, $id, $index);
 ipworksencrypt_jwe_do_addheaderparam($res, $name, $value, $datatype);
 ipworksencrypt_jwe_do_config($res, $configurationstring);
 ipworksencrypt_jwe_do_decrypt($res);
 ipworksencrypt_jwe_do_encrypt($res);
 ipworksencrypt_jwe_do_parse($res);
 ipworksencrypt_jwe_do_reset($res);
```

## Remarks

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

Specify any payload via input properties and use [Encrypt](#encrypt-method-ipworksencrypt_jwe-class) to create a JWE message using a variety of algorithms including ECDH, RSA, and AES. Use [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) for more details about supported algorithms.

## Encrypting

The [Encrypt](#encrypt-method-ipworksencrypt_jwe-class) 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](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class). 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](#keyid-property-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) (required)
- [Key](#key-property-ipworksencrypt_jwe-class) (conditional - required for AES)
- [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) (conditional - required for PBES)
- Certificate (conditional - required for ECDH and RSA)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class)
- [CompressionAlgorithm](#CompressionAlgorithm)
- HeaderParams
- [Overwrite](#overwrite-property-ipworksencrypt_jwe-class)

**Input and Output Properties**

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

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

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

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

- [OutputFile](#outputfile-property-ipworksencrypt_jwe-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_jwe-class): 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) is set to a AES algorithm [Key](#key-property-ipworksencrypt_jwe-class) 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](#key-property-ipworksencrypt_jwe-class) 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 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](#keypassword-property-ipworksencrypt_jwe-class) property. Set [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) is set to *Direct* the [Key](#key-property-ipworksencrypt_jwe-class) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). In this case a content encryption key is not generated randomly, the [Key](#key-property-ipworksencrypt_jwe-class) is used instead. The length of the specified [Key](#key-property-ipworksencrypt_jwe-class) must be valid for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). 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](#decrypt-method-ipworksencrypt_jwe-class) method may be used to decrypt a received JWE message. Before calling the [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) method set [InputMessage](#inputmessage-property-ipworksencrypt_jwe-class) or [InputFile](#inputfile-property-ipworksencrypt_jwe-class) 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](#key-property-ipworksencrypt_jwe-class) |
| RSA and ECDH | Certificate |
| PBES | [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) |

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

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

The following properties are applicable when calling this method:

- Certificate (conditional - required for RSA and ECDH)
- [Key](#key-property-ipworksencrypt_jwe-class) (conditional - required for AES)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class) (only if [StrictValidation](#StrictValidation) is True)
- [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class) (only if [StrictValidation](#StrictValidation) is True)
- HeaderParams
- [Overwrite](#overwrite-property-ipworksencrypt_jwe-class)
- [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](#inputfile-property-ipworksencrypt_jwe-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_jwe-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_jwe-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_jwe-class): 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](#key-property-ipworksencrypt_jwe-class) 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 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](#keypassword-property-ipworksencrypt_jwe-class) property. Set [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) 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](#key-property-ipworksencrypt_jwe-class) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). 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](#addheaderparam-method-ipworksencrypt_jwe-class)
- Enforcing algorithm restrictions when decrypting by setting [StrictValidation](#StrictValidation)
- Inspect the JWE headers without decrypting by calling [Parse](#parse-method-ipworksencrypt_jwe-class)

## Property List

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

|  |  |
| --- | --- |
| [CertEffectiveDate](#certeffectivedate-property-ipworksencrypt_jwe-class) | The date on which this certificate becomes valid. |
| [CertExpirationDate](#certexpirationdate-property-ipworksencrypt_jwe-class) | The date on which the certificate expires. |
| [CertExtendedKeyUsage](#certextendedkeyusage-property-ipworksencrypt_jwe-class) | A comma-delimited list of extended key usage identifiers. |
| [CertFingerprint](#certfingerprint-property-ipworksencrypt_jwe-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [CertFingerprintSHA1](#certfingerprintsha1-property-ipworksencrypt_jwe-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [CertFingerprintSHA256](#certfingerprintsha256-property-ipworksencrypt_jwe-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [CertIssuer](#certissuer-property-ipworksencrypt_jwe-class) | The issuer of the certificate. |
| [CertPrivateKey](#certprivatekey-property-ipworksencrypt_jwe-class) | The private key of the certificate (if available). |
| [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_jwe-class) | Whether a PrivateKey is available for the selected certificate. |
| [CertPrivateKeyContainer](#certprivatekeycontainer-property-ipworksencrypt_jwe-class) | The name of the PrivateKey container for the certificate (if available). |
| [CertPublicKey](#certpublickey-property-ipworksencrypt_jwe-class) | The public key of the certificate. |
| [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-ipworksencrypt_jwe-class) | The textual description of the certificate's public key algorithm. |
| [CertPublicKeyLength](#certpublickeylength-property-ipworksencrypt_jwe-class) | The length of the certificate's public key (in bits). |
| [CertSerialNumber](#certserialnumber-property-ipworksencrypt_jwe-class) | The serial number of the certificate encoded as a string. |
| [CertSignatureAlgorithm](#certsignaturealgorithm-property-ipworksencrypt_jwe-class) | The text description of the certificate's signature algorithm. |
| [CertStore](#certstore-property-ipworksencrypt_jwe-class) | The name of the certificate store for the client certificate. |
| [CertStorePassword](#certstorepassword-property-ipworksencrypt_jwe-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [CertStoreType](#certstoretype-property-ipworksencrypt_jwe-class) | The type of certificate store for this certificate. |
| [CertSubjectAltNames](#certsubjectaltnames-property-ipworksencrypt_jwe-class) | Comma-separated lists of alternative subject names for the certificate. |
| [CertThumbprintMD5](#certthumbprintmd5-property-ipworksencrypt_jwe-class) | The MD5 hash of the certificate. |
| [CertThumbprintSHA1](#certthumbprintsha1-property-ipworksencrypt_jwe-class) | The SHA-1 hash of the certificate. |
| [CertThumbprintSHA256](#certthumbprintsha256-property-ipworksencrypt_jwe-class) | The SHA-256 hash of the certificate. |
| [CertUsage](#certusage-property-ipworksencrypt_jwe-class) | The text description of UsageFlags . |
| [CertUsageFlags](#certusageflags-property-ipworksencrypt_jwe-class) | The flags that show intended use for the certificate. |
| [CertVersion](#certversion-property-ipworksencrypt_jwe-class) | The certificate's version number. |
| [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) | The subject of the certificate used for client authentication. |
| [CertEncoded](#certencoded-property-ipworksencrypt_jwe-class) | The certificate (PEM/Base64 encoded). |
| [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class) | The algorithm used to encrypt the content. |
| [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class) | The key encryption algorithm. |
| [HeaderParamCount](#headerparamcount-property-ipworksencrypt_jwe-class) | The number of records in the HeaderParam arrays. |
| [HeaderParamDataType](#headerparamdatatype-property-ipworksencrypt_jwe-class) | The data type of the header parameter. |
| [HeaderParamName](#headerparamname-property-ipworksencrypt_jwe-class) | The header parameter name. |
| [HeaderParamValue](#headerparamvalue-property-ipworksencrypt_jwe-class) | The header parameter value. |
| [InputFile](#inputfile-property-ipworksencrypt_jwe-class) | The file to process. |
| [InputMessage](#inputmessage-property-ipworksencrypt_jwe-class) | The message to process. |
| [Key](#key-property-ipworksencrypt_jwe-class) | The secret key for the AES algorithm. |
| [KeyId](#keyid-property-ipworksencrypt_jwe-class) | The Id of the key used to encrypt the message. |
| [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) | The key password used in the PBES algorithm. |
| [OutputFile](#outputfile-property-ipworksencrypt_jwe-class) | The output file when encrypting or decrypting. |
| [OutputMessage](#outputmessage-property-ipworksencrypt_jwe-class) | The output message after processing. |
| [Overwrite](#overwrite-property-ipworksencrypt_jwe-class) | 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](#addheaderparam-method-ipworksencrypt_jwe-class) | Adds additional header parameters. |
| [Config](#config-method-ipworksencrypt_jwe-class) | Sets or retrieves a configuration setting. |
| [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) | Decrypts the payload. |
| [Encrypt](#encrypt-method-ipworksencrypt_jwe-class) | Encrypts the payload with the specified algorithms. |
| [Parse](#parse-method-ipworksencrypt_jwe-class) | Parses the compact serialized JWE string. |
| [Reset](#reset-method-ipworksencrypt_jwe-class) | Resets the class. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#error-event-ipworksencrypt_jwe-class) | Fired when information is available about errors during data delivery. |
| [HeaderParam](#headerparam-event-ipworksencrypt_jwe-class) | Fires once for each JOSE header parameter. |
| [RecipientInfo](#recipientinfo-event-ipworksencrypt_jwe-class) | 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. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# CertEffectiveDate Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getCertEffectiveDate();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 1 );
```

## Default Value

''

## Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# CertExpirationDate Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getCertExpirationDate();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 2 );
```

## Default Value

''

## Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# CertExtendedKeyUsage Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 3 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertFingerprint Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprint();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 4 );
```

## Default Value

''

## Remarks

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

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

This property is read-only.

## Data Type

String

# CertFingerprintSHA1 Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 5 );
```

## Default Value

''

## Remarks

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

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

This property is read-only.

## Data Type

String

# CertFingerprintSHA256 Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Object Oriented Interface

```text
public function getCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 6 );
```

## Default Value

''

## Remarks

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

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

This property is read-only.

## Data Type

String

# CertIssuer Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getCertIssuer();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 7 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertPrivateKey Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getCertPrivateKey();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 8 );
```

## Default Value

''

## Remarks

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

NOTE: The [CertPrivateKey](#certprivatekey-property-ipworksencrypt_jwe-class) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-ipworksencrypt_jwe-class) returns an empty string.

This property is read-only.

## Data Type

String

# CertPrivateKeyAvailable Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 9 );
```

## Default Value

false

## Remarks

Whether a [CertPrivateKey](#certprivatekey-property-ipworksencrypt_jwe-class) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworksencrypt_jwe-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# CertPrivateKeyContainer Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The name of the PrivateKey container for the certificate (if available).

## Object Oriented Interface

```text
public function getCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 10 );
```

## Default Value

''

## Remarks

The name of the [CertPrivateKey](#certprivatekey-property-ipworksencrypt_jwe-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# CertPublicKey Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getCertPublicKey();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 11 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertPublicKeyAlgorithm Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The textual description of the certificate's public key algorithm.

## Object Oriented Interface

```text
public function getCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 12 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertPublicKeyLength Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The length of the certificate's public key (in bits).

## Object Oriented Interface

```text
public function getCertPublicKeyLength();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 13 );
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

Integer

# CertSerialNumber Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getCertSerialNumber();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 14 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertSignatureAlgorithm Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 15 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertStore Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getCertStore();
public function setCertStore($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 16 );
ipworksencrypt_jwe_set($res, 16, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [CertStoreType](#certstoretype-property-ipworksencrypt_jwe-class) property denotes the type of the certificate store specified by [CertStore](#certstore-property-ipworksencrypt_jwe-class). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-ipworksencrypt_jwe-class).

[CertStore](#certstore-property-ipworksencrypt_jwe-class) is used in conjunction with the [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) property to specify client certificates. If [CertStore](#certstore-property-ipworksencrypt_jwe-class) has a value, and [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) or [CertEncoded](#certencoded-property-ipworksencrypt_jwe-class) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) 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).

## Data Type

Binary String

# CertStorePassword Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

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

## Object Oriented Interface

```text
public function getCertStorePassword();
public function setCertStorePassword($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 17 );
ipworksencrypt_jwe_set($res, 17, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# CertStoreType Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getCertStoreType();
public function setCertStoreType($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 18 );
ipworksencrypt_jwe_set($res, 18, $value );
```

## Possible Values

```text
JWE_CERTSTORETYPE_USER(0), JWE_CERTSTORETYPE_MACHINE(1), JWE_CERTSTORETYPE_PFXFILE(2), JWE_CERTSTORETYPE_PFXBLOB(3), JWE_CERTSTORETYPE_JKSFILE(4), JWE_CERTSTORETYPE_JKSBLOB(5), JWE_CERTSTORETYPE_PEMKEY_FILE(6), JWE_CERTSTORETYPE_PEMKEY_BLOB(7), JWE_CERTSTORETYPE_PUBLIC_KEY_FILE(8), JWE_CERTSTORETYPE_PUBLIC_KEY_BLOB(9), JWE_CERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), JWE_CERTSTORETYPE_P7BFILE(11), JWE_CERTSTORETYPE_P7BBLOB(12), JWE_CERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), JWE_CERTSTORETYPE_PPKFILE(14), JWE_CERTSTORETYPE_PPKBLOB(15), JWE_CERTSTORETYPE_XMLFILE(16), JWE_CERTSTORETYPE_XMLBLOB(17), JWE_CERTSTORETYPE_JWKFILE(18), JWE_CERTSTORETYPE_JWKBLOB(19), JWE_CERTSTORETYPE_SECURITY_KEY(20), JWE_CERTSTORETYPE_BCFKSFILE(21), JWE_CERTSTORETYPE_BCFKSBLOB(22), JWE_CERTSTORETYPE_PKCS11(23), JWE_CERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

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](#Type_Certificate) object and pass cstPKCS11 as the [CertStoreType](#certstoretype-property-ipworksencrypt_jwe-class), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-ipworksencrypt_jwe-class), and the PIN as the [CertStorePassword](#certstorepassword-property-ipworksencrypt_jwe-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [CertStore](#certstore-property-ipworksencrypt_jwe-class) and set [CertStorePassword](#certstorepassword-property-ipworksencrypt_jwe-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# CertSubjectAltNames Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

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

## Object Oriented Interface

```text
public function getCertSubjectAltNames();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 19 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertThumbprintMD5 Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintMD5();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 20 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertThumbprintSHA1 Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 21 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertThumbprintSHA256 Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 22 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertUsage Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getCertUsage();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 23 );
```

## Default Value

''

## Remarks

The text description of [CertUsageFlags](#certusageflags-property-ipworksencrypt_jwe-class).

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

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

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

This property is read-only.

## Data Type

String

# CertUsageFlags Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getCertUsageFlags();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 24 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-ipworksencrypt_jwe-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [CertUsage](#certusage-property-ipworksencrypt_jwe-class) property for a text representation of [CertUsageFlags](#certusageflags-property-ipworksencrypt_jwe-class).

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

This property is read-only.

## Data Type

Integer

# CertVersion Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getCertVersion();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 25 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# CertSubject Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getCertSubject();
public function setCertSubject($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 26 );
ipworksencrypt_jwe_set($res, 26, $value );
```

## Default Value

''

## Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# CertEncoded Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getCertEncoded();
public function setCertEncoded($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 27 );
ipworksencrypt_jwe_set($res, 27, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-ipworksencrypt_jwe-class) and [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) properties also may be used to specify a certificate.

When [CertEncoded](#certencoded-property-ipworksencrypt_jwe-class) is set, a search is initiated in the current [CertStore](#certstore-property-ipworksencrypt_jwe-class) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-ipworksencrypt_jwe-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# ContentEncryptionAlgorithm Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The algorithm used to encrypt the content.

## Object Oriented Interface

```text
public function getContentEncryptionAlgorithm();
public function setContentEncryptionAlgorithm($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 28 );
ipworksencrypt_jwe_set($res, 28, $value );
```

## Possible Values

```text
JWE_CONTENTENCRYPTIONALGORITHM_A128CBC_HS256(0), JWE_CONTENTENCRYPTIONALGORITHM_A192CBC_HS384(1), JWE_CONTENTENCRYPTIONALGORITHM_A256CBC_HS512(2), JWE_CONTENTENCRYPTIONALGORITHM_A128GCM(3), JWE_CONTENTENCRYPTIONALGORITHM_A192GCM(4), JWE_CONTENTENCRYPTIONALGORITHM_A256GCM(5)
```

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

## Data Type

Integer

# EncryptionAlgorithm Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The key encryption algorithm.

## Object Oriented Interface

```text
public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 29 );
ipworksencrypt_jwe_set($res, 29, $value );
```

## Possible Values

```text
JWE_ENCRYPTIONALGORITHM_RSA1_5(0), JWE_ENCRYPTIONALGORITHM_RSA_OAEP(1), JWE_ENCRYPTIONALGORITHM_RSA_OAEP_256(2), JWE_ENCRYPTIONALGORITHM_A128KW(3), JWE_ENCRYPTIONALGORITHM_A192KW(4), JWE_ENCRYPTIONALGORITHM_A256KW(5), JWE_ENCRYPTIONALGORITHM_DIR(6), JWE_ENCRYPTIONALGORITHM_ECDH_ES(7), JWE_ENCRYPTIONALGORITHM_ECDH_ES_A128KW(8), JWE_ENCRYPTIONALGORITHM_ECDH_ES_A192KW(9), JWE_ENCRYPTIONALGORITHM_ECDH_ES_A256KW(10), JWE_ENCRYPTIONALGORITHM_A128GCMKW(11), JWE_ENCRYPTIONALGORITHM_A192GCMKW(12), JWE_ENCRYPTIONALGORITHM_A256GCMKW(13), JWE_ENCRYPTIONALGORITHM_PBES2_HS256_A128KW(14), JWE_ENCRYPTIONALGORITHM_PBES2_HS384_A192KW(15), JWE_ENCRYPTIONALGORITHM_PBES2_HS512_A256KW(16)
```

## Default Value

0

## Remarks

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

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

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

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)

## Data Type

Integer

# HeaderParamCount Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The number of records in the HeaderParam arrays.

## Object Oriented Interface

```text
public function getHeaderParamCount();
public function setHeaderParamCount($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 30 );
ipworksencrypt_jwe_set($res, 30, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [HeaderParamDataType](#headerparamdatatype-property-ipworksencrypt_jwe-class)
- [HeaderParamName](#headerparamname-property-ipworksencrypt_jwe-class)
- [HeaderParamValue](#headerparamvalue-property-ipworksencrypt_jwe-class)

The array indices start at *0* and end at *HeaderParamCount - 1*.

This property is not available at design time.

## Data Type

Integer

# HeaderParamDataType Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The data type of the header parameter.

## Object Oriented Interface

```text
public function getHeaderParamDataType($headerparamindex);
public function setHeaderParamDataType($headerparamindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 31 , $headerparamindex);
ipworksencrypt_jwe_set($res, 31, $value , $headerparamindex);
```

## Possible Values

```text
JWE_HEADERPARAMDATATYPE_OBJECT(0), JWE_HEADERPARAMDATATYPE_ARRAY(1), JWE_HEADERPARAMDATATYPE_STRING(2), JWE_HEADERPARAMDATATYPE_NUMBER(3), JWE_HEADERPARAMDATATYPE_BOOL(4), JWE_HEADERPARAMDATATYPE_NULL(5)
```

## Default Value

2

## Remarks

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)

The *$headerparamindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [HeaderParamCount](#headerparamcount-property-ipworksencrypt_jwe-class) property.

This property is not available at design time.

## Data Type

Integer

# HeaderParamName Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The header parameter name.

## Object Oriented Interface

```text
public function getHeaderParamName($headerparamindex);
public function setHeaderParamName($headerparamindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 32 , $headerparamindex);
ipworksencrypt_jwe_set($res, 32, $value , $headerparamindex);
```

## Default Value

''

## Remarks

The header parameter name.

The *$headerparamindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [HeaderParamCount](#headerparamcount-property-ipworksencrypt_jwe-class) property.

This property is not available at design time.

## Data Type

String

# HeaderParamValue Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The header parameter value.

## Object Oriented Interface

```text
public function getHeaderParamValue($headerparamindex);
public function setHeaderParamValue($headerparamindex, $value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 33 , $headerparamindex);
ipworksencrypt_jwe_set($res, 33, $value , $headerparamindex);
```

## Default Value

''

## Remarks

The header parameter value.

The *$headerparamindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [HeaderParamCount](#headerparamcount-property-ipworksencrypt_jwe-class) property.

This property is not available at design time.

## Data Type

String

# InputFile Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The file to process.

## Object Oriented Interface

```text
public function getInputFile();
public function setInputFile($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 34 );
ipworksencrypt_jwe_set($res, 34, $value );
```

## 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](#inputmessage-property-ipworksencrypt_jwe-class)

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

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

## Data Type

String

# InputMessage Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The message to process.

## Object Oriented Interface

```text
public function getInputMessage();
public function setInputMessage($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 35 );
ipworksencrypt_jwe_set($res, 35, $value );
```

## 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](#inputfile-property-ipworksencrypt_jwe-class)
- InputMessage

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

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

## Data Type

Binary String

# Key Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The secret key for the AES algorithm.

## Object Oriented Interface

```text
public function getKey();
public function setKey($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 36 );
ipworksencrypt_jwe_set($res, 36, $value );
```

## Default Value

''

## Remarks

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

When [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) is set to *Direct* this key is used directly with the algorithm specified by [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class) and must be an appropriate size for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class).

## Data Type

Binary String

# KeyId Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The Id of the key used to encrypt the message.

## Object Oriented Interface

```text
public function getKeyId();
public function setKeyId($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 37 );
ipworksencrypt_jwe_set($res, 37, $value );
```

## 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](#encrypt-method-ipworksencrypt_jwe-class) method.

## Data Type

String

# KeyPassword Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The key password used in the PBES algorithm.

## Object Oriented Interface

```text
public function getKeyPassword();
public function setKeyPassword($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 38 );
ipworksencrypt_jwe_set($res, 38, $value );
```

## Default Value

''

## Remarks

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

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

## Data Type

String

# OutputFile Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The output file when encrypting or decrypting.

## Object Oriented Interface

```text
public function getOutputFile();
public function setOutputFile($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 39 );
ipworksencrypt_jwe_set($res, 39, $value );
```

## Default Value

''

## Remarks

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

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

**Input and Output Properties**

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

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

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

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

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

## Data Type

String

# OutputMessage Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

The output message after processing.

## Object Oriented Interface

```text
public function getOutputMessage();
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 40 );
```

## Default Value

''

## Remarks

This property will be populated with the output from the operation if [OutputFile](#outputfile-property-ipworksencrypt_jwe-class) 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](#inputfile-property-ipworksencrypt_jwe-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_jwe-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_jwe-class)
- 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.

## Data Type

Binary String

# Overwrite Property ([IPWorksEncrypt_JWE](#jwe-class) Class)

Indicates whether or not the class should overwrite files.

## Object Oriented Interface

```text
public function getOverwrite();
public function setOverwrite($value);
```

## Procedural Interface

```text
ipworksencrypt_jwe_get($res, 41 );
ipworksencrypt_jwe_set($res, 41, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# AddHeaderParam Method ([IPWorksEncrypt_JWE](#jwe-class) Class)

Adds additional header parameters.

## Object Oriented Interface

```text
public function doAddHeaderParam($name, $value, $datatype);
```

## Procedural Interface

```text
ipworksencrypt_jwe_do_addheaderparam($res, $name, $value, $datatype);
```

## Remarks

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

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](#encrypt-method-ipworksencrypt_jwe-class) the class will automatically add headers based on the selected [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class) and other properties that may be set.

**Parameters Automatically Set:**

| Header Param | Property |
| --- | --- |
| alg | [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class) |
| enc | [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class) |
| kid | [KeyId](#keyid-property-ipworksencrypt_jwe-class) |
| 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) |

# Config Method ([IPWorksEncrypt_JWE](#jwe-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworksencrypt_jwe_do_config($res, $configurationstring);
```

## Remarks

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

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

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

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

# Decrypt Method ([IPWorksEncrypt_JWE](#jwe-class) Class)

Decrypts the payload.

## Object Oriented Interface

```text
public function doDecrypt();
```

## Procedural Interface

```text
ipworksencrypt_jwe_do_decrypt($res);
```

## Remarks

This method decrypts the input data.

Before calling the Decrypt method set [InputMessage](#inputmessage-property-ipworksencrypt_jwe-class) or [InputFile](#inputfile-property-ipworksencrypt_jwe-class) 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](#key-property-ipworksencrypt_jwe-class) |
| RSA and ECDH | Certificate |
| PBES | [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) |

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

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

The following properties are applicable when calling this method:

- Certificate (conditional - required for RSA and ECDH)
- [Key](#key-property-ipworksencrypt_jwe-class) (conditional - required for AES)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class) (only if [StrictValidation](#StrictValidation) is True)
- [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class) (only if [StrictValidation](#StrictValidation) is True)
- HeaderParams
- [Overwrite](#overwrite-property-ipworksencrypt_jwe-class)
- [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](#inputfile-property-ipworksencrypt_jwe-class)
- [InputMessage](#inputmessage-property-ipworksencrypt_jwe-class)

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

- [OutputFile](#outputfile-property-ipworksencrypt_jwe-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_jwe-class): 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](#key-property-ipworksencrypt_jwe-class) 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 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](#keypassword-property-ipworksencrypt_jwe-class) property. Set [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) 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](#key-property-ipworksencrypt_jwe-class) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). 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;
```

# Encrypt Method ([IPWorksEncrypt_JWE](#jwe-class) Class)

Encrypts the payload with the specified algorithms.

## Object Oriented Interface

```text
public function doEncrypt();
```

## Procedural Interface

```text
ipworksencrypt_jwe_do_encrypt($res);
```

## 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](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). The content encryption key is then encrypted itself using the algorithm specified by [EncryptionAlgorithm](#encryptionalgorithm-property-ipworksencrypt_jwe-class). 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](#keyid-property-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) (required)
- [Key](#key-property-ipworksencrypt_jwe-class) (conditional - required for AES)
- [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) (conditional - required for PBES)
- Certificate (conditional - required for ECDH and RSA)
- [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class)
- [CompressionAlgorithm](#CompressionAlgorithm)
- HeaderParams
- [Overwrite](#overwrite-property-ipworksencrypt_jwe-class)

**Input and Output Properties**

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

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

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

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

- [OutputFile](#outputfile-property-ipworksencrypt_jwe-class)
- [OutputMessage](#outputmessage-property-ipworksencrypt_jwe-class): 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) is set to a AES algorithm [Key](#key-property-ipworksencrypt_jwe-class) 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](#key-property-ipworksencrypt_jwe-class) 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 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](#keypassword-property-ipworksencrypt_jwe-class) property. Set [KeyPassword](#keypassword-property-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) is set to *Direct* the [Key](#key-property-ipworksencrypt_jwe-class) property must be set to a valid symmetric key that will be used directly by the [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). In this case a content encryption key is not generated randomly, the [Key](#key-property-ipworksencrypt_jwe-class) is used instead. The length of the specified [Key](#key-property-ipworksencrypt_jwe-class) must be valid for the selected [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). 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;
```

# Parse Method ([IPWorksEncrypt_JWE](#jwe-class) Class)

Parses the compact serialized JWE string.

## Object Oriented Interface

```text
public function doParse();
```

## Procedural Interface

```text
ipworksencrypt_jwe_do_parse($res);
```

## 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](#decrypt-method-ipworksencrypt_jwe-class) instead. It is not necessary to call this method before calling [Decrypt](#decrypt-method-ipworksencrypt_jwe-class). [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) will both parse and decrypt the message.

When calling this method the headers are parsed. The [HeaderParam](#headerparam-event-ipworksencrypt_jwe-class) and [RecipientInfo](#recipientinfo-event-ipworksencrypt_jwe-class) events will fire and the HeaderParams property will be populated.

# Reset Method ([IPWorksEncrypt_JWE](#jwe-class) Class)

Resets the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworksencrypt_jwe_do_reset($res);
```

## Remarks

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

# Error Event ([IPWorksEncrypt_JWE](#jwe-class) Class)

Fired when information is available about errors during data delivery.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworksencrypt_jwe_register_callback($res, 1, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## Remarks

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

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

# HeaderParam Event ([IPWorksEncrypt_JWE](#jwe-class) Class)

Fires once for each JOSE header parameter.

## Object Oriented Interface

```text
public function fireHeaderParam($param);
```

## Procedural Interface

```text
ipworksencrypt_jwe_register_callback($res, 2, array($this, 'fireHeaderParam'));
```

## Parameter List

```text
 'name' 'value' 'datatype'
```

## Remarks

When [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) or [Parse](#parse-method-ipworksencrypt_jwe-class) 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)

# RecipientInfo Event ([IPWorksEncrypt_JWE](#jwe-class) Class)

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

## Object Oriented Interface

```text
public function fireRecipientInfo($param);
```

## Procedural Interface

```text
ipworksencrypt_jwe_register_callback($res, 3, array($this, 'fireRecipientInfo'));
```

## Parameter List

```text
 'keyid' 'algorithm'
```

## Remarks

This event fires with information about the key used to encrypt the data. This may be used to help identify the [Key](#key-property-ipworksencrypt_jwe-class) or Certificate to load in order to decrypt the message. This event fires when [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) or [Parse](#parse-method-ipworksencrypt_jwe-class) 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.

# Config Settings ([JWE](#jwe-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-ipworksencrypt_jwe-class) 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](#encrypt-method-ipworksencrypt_jwe-class). When calling [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) this setting is populated and also accessible from within the [RecipientInfo](#recipientinfo-event-ipworksencrypt_jwe-class) 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](#encrypt-method-ipworksencrypt_jwe-class). When calling [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) this setting is populated and also accessible from within the [RecipientInfo](#recipientinfo-event-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) is set to a PBES algorithm.

**RawHeader**: Holds the raw JOSE header.This setting may be queried after calling [Encrypt](#encrypt-method-ipworksencrypt_jwe-class) or [Decrypt](#decrypt-method-ipworksencrypt_jwe-class) 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](#encryptionalgorithm-property-ipworksencrypt_jwe-class) and [ContentEncryptionAlgorithm](#contentencryptionalgorithm-property-ipworksencrypt_jwe-class). If either algorithms do not match the class fails with an error.

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

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

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

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

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

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

NOTE: This setting is applicable only on Windows.

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

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

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

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

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

# Trappable Errors ([JWE](#jwe-class) 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. |