JWE Class

Properties Methods Events Config Settings Errors

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

Syntax

class ipworksencrypt.JWE

Remarks

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

Specify any payload via input properties and use encrypt to create a JWE message using a variety of algorithms including ECDH, RSA, and AES. Use decrypt to decrypt the payload of any received JWE message. The following algorithms are supported:

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

See encryption_algorithm for more details about supported algorithms.

Encrypting

The encrypt 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 content_encryption_algorithm. The content encryption key is then encrypted itself using the algorithm specified by encryption_algorithm. 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. key_id 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:

encryption_algorithm (required)
key (conditional - required for AES)
key_password (conditional - required for PBES)
certificate (conditional - required for ECDH and RSA)
content_encryption_algorithm
CompressionAlgorithm
Header*
overwrite

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:

input_file
input_message

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

output_file
output_message: 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 encryption_algorithm is set to a AES algorithm key 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 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.

//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 property. For instance:

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:

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:

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:

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 key_password property. Set key_password to a shared secret.

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 encryption_algorithm is set to Direct the key property must be set to a valid symmetric key that will be used directly by the content_encryption_algorithm. In this case a content encryption key is not generated randomly, the key is used instead. The length of the specified key must be valid for the selected content_encryption_algorithm. For instance:

//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 method may be used to decrypt a received JWE message. Before calling the decrypt method set input_message or input_file to a valid compact serialized JWE string. For instance:

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
RSA and ECDH	certificate
PBES	key_password

If the correct key or certificate is not known ahead of time the KeyId parameter of the on_recipient_info 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 output_message or file specified by output_file and the Header* properties will contain the headers. Headers of the parsed message are also available through the on_header_param event.

The following properties are applicable when calling this method:

certificate (conditional - required for RSA and ECDH)
key (conditional - required for AES)
content_encryption_algorithm (only if StrictValidation is True)
encryption_algorithm (only if StrictValidation is True)
Header*
overwrite
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:

input_file
input_message

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

output_file
output_message: 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 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.

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:

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.

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:

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 key_password property. Set key_password to the shared secret.

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 property must be set to a valid symmetric key that will be used directly by the content_encryption_algorithm. For instance:

Other Functionality

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

Adding custom header parameters with add_header_param
Enforcing algorithm restrictions when decrypting by setting StrictValidation
Inspect the JWE headers without decrypting by calling parse

Property List

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


cert_encoded	This is the certificate (PEM/Base64 encoded).
cert_store	This is the name of the certificate store for the client certificate.
cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
cert_store_type	This is the type of certificate store for this certificate.
cert_subject	This is the subject of the certificate used for client authentication.
content_encryption_algorithm	The algorithm used to encrypt the content.
encryption_algorithm	The key encryption algorithm.
header_param_count	The number of records in the HeaderParam arrays.
header_param_data_type	The data type of the header parameter.
header_param_name	The header parameter name.
header_param_value	The header parameter value.
input_file	The file to process.
input_message	The message to process.
key	The secret key for the AES algorithm.
key_id	The Id of the key used to encrypt the message.
key_password	The key password used in the PBES algorithm.
output_file	The output file when encrypting or decrypting.
output_message	The output message after processing.
overwrite	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.


add_header_param	Adds additional header parameters.
config	Sets or retrieves a configuration setting.
decrypt	Decrypts the payload.
encrypt	Encrypts the payload with the specified algorithms.
parse	Parses the compact serialized JWE string.
reset	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.


on_error	Fired when information is available about errors during data delivery.
on_header_param	Fires once for each JOSE header parameter.
on_recipient_info	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	The compression algorithm to use.
PartyUInfo	Information about the producer of the message.
PartyVInfo	Information about the recipient of the message.
PBES2Count	The PBKDF2 iteration count.
PBES2SaltLength	The salt input value length.
RawHeader	Holds the raw JOSE header.
StrictValidation	Requires specific algorithm when decrypting.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_cert_encoded() -> bytes: ...
def set_cert_encoded(value: bytes) -> None: ...

cert_encoded = property(get_cert_encoded, set_cert_encoded)

Default Value

Remarks

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

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

cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_cert_store() -> bytes: ...
def set_cert_store(value: bytes) -> None: ...

cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

cert_store_password Property

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

Syntax

def get_cert_store_password() -> str: ...
def set_cert_store_password(value: str) -> None: ...

cert_store_password = property(get_cert_store_password, set_cert_store_password)

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.

cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_cert_store_type() -> int: ...
def set_cert_store_type(value: int) -> None: ...

cert_store_type = property(get_cert_store_type, set_cert_store_type)

Default Value

Remarks

This is 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:


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, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN. Code Example. SSH Authentication with Security Key: `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);`
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.

cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_cert_subject() -> str: ...
def set_cert_subject(value: str) -> None: ...

cert_subject = property(get_cert_subject, set_cert_subject)

Default Value

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

content_encryption_algorithm Property

The algorithm used to encrypt the content.

Syntax

def get_content_encryption_algorithm() -> int: ...
def set_content_encryption_algorithm(value: int) -> None: ...

content_encryption_algorithm = property(get_content_encryption_algorithm, set_content_encryption_algorithm)

Default Value

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

encryption_algorithm Property

The key encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

Remarks

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

When using an AES algorithm key must be specified. When using an RSA or ECDH algorithm certificate must be specified. When using a PBES algorithm key_password must be specified;. Possible values are:


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

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

PartyUInfo
PartyVInfo

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

PBES2Count
PBES2SaltLength

header_param_count Property

The number of records in the HeaderParam arrays.

Syntax

def get_header_param_count() -> int: ...
def set_header_param_count(value: int) -> None: ...

header_param_count = property(get_header_param_count, set_header_param_count)

Default Value

Remarks

This property controls the size of the following arrays:

header_param_data_type
header_param_name
header_param_value

The array indices start at 0 and end at header_param_count - 1.

header_param_data_type Property

The data type of the header parameter.

Syntax

def get_header_param_data_type(header_param_index: int) -> int: ...
def set_header_param_data_type(header_param_index: int, value: int) -> None: ...

Default Value

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 header_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the header_param_count property.

header_param_name Property

The header parameter name.

Syntax

def get_header_param_name(header_param_index: int) -> str: ...
def set_header_param_name(header_param_index: int, value: str) -> None: ...

Default Value

Remarks

The header parameter name.

The header_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the header_param_count property.

header_param_value Property

The header parameter value.

Syntax

def get_header_param_value(header_param_index: int) -> str: ...
def set_header_param_value(header_param_index: int, value: str) -> None: ...

Default Value

Remarks

The header parameter value.

The header_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the header_param_count property.

input_file Property

The file to process.

Syntax

def get_input_file() -> str: ...
def set_input_file(value: str) -> None: ...

input_file = property(get_input_file, set_input_file)

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:

input_file
input_message

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

output_file
output_message: The output data is written to this property if no other destination is specified.

input_message Property

The message to process.

Syntax

def get_input_message() -> bytes: ...
def set_input_message(value: bytes) -> None: ...

input_message = property(get_input_message, set_input_message)

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:

input_file
input_message

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

output_file
output_message: The output data is written to this property if no other destination is specified.

key Property

The secret key for the AES algorithm.

Syntax

def get_key() -> bytes: ...
def set_key(value: bytes) -> None: ...

key = property(get_key, set_key)

Default Value

Remarks

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

When encryption_algorithm 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 encryption_algorithm is set to Direct this key is used directly with the algorithm specified by content_encryption_algorithm and must be an appropriate size for the selected content_encryption_algorithm.

key_id Property

The Id of the key used to encrypt the message.

Syntax

def get_key_id() -> str: ...
def set_key_id(value: str) -> None: ...

key_id = property(get_key_id, set_key_id)

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

key_password Property

The key password used in the PBES algorithm.

Syntax

def get_key_password() -> str: ...
def set_key_password(value: str) -> None: ...

key_password = property(get_key_password, set_key_password)

Default Value

Remarks

This property specifies the key password used to derive a key when using a PBES encryption_algorithm.

This is only applicable to PBES algorithms and must be set before calling encrypt or decrypt.

output_file Property

The output file when encrypting or decrypting.

Syntax

def get_output_file() -> str: ...
def set_output_file(value: str) -> None: ...

output_file = property(get_output_file, set_output_file)

Default Value

Remarks

This property specifies the file to which the output will be written when encrypt or decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to encrypt and decrypt.

Input and Output Properties

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

input_file
input_message

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

output_file
output_message: The output data is written to this property if no other destination is specified.

output_message Property

The output message after processing.

Syntax

def get_output_message() -> bytes: ...

output_message = property(get_output_message, None)

Default Value

Remarks

This property will be populated with the output from the operation if output_file 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:

input_file
input_message

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

output_file
output_message: The output data is written to this property if no other destination is specified.

This property is read-only.

overwrite Property

Indicates whether or not the class should overwrite files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite output_file. If overwrite is False, an error will be thrown whenever output_file exists before an operation. The default value is False.

add_header_param Method

Adds additional header parameters.

Syntax

def add_header_param(name: str, value: str, data_type: int) -> None: ...

Remarks

This method is used to add additional header parameters before calling encrypt.

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:

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

The following code can be used:

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 the class will automatically add headers based on the selected encryption_algorithm and other properties that may be set.

Parameters Automatically Set:


Header Param	Property
`alg`	encryption_algorithm
`enc`	content_encryption_algorithm
`kid`	key_id
`zip`	CompressionAlgorithm
`p2c`	PBES2Count (PBES Algorithms Only)
`apu`	PartyUInfo (ECDH Algorithms Only)
`apv`	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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

decrypt Method

Decrypts the payload.

Syntax

def decrypt() -> None: ...

Remarks

This method decrypts the input data.

Before calling the decrypt method set input_message or input_file to a valid compact serialized JWE string. For instance:

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
RSA and ECDH	certificate
PBES	key_password

If the correct key or certificate is not known ahead of time the KeyId parameter of the on_recipient_info event may be used to identify the correct key.

The following properties are applicable when calling this method:

certificate (conditional - required for RSA and ECDH)
key (conditional - required for AES)
content_encryption_algorithm (only if StrictValidation is True)
encryption_algorithm (only if StrictValidation is True)
Header*
overwrite
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:

input_file
input_message

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

output_file
output_message: The output data is written to this property if no other destination is specified.