JWE Control

Properties Methods Events Config Settings Errors

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

Syntax

JWE

Remarks

The JWE control 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
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 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 ContentEncryptionAlgorithm. The content encryption key is then encrypted itself using the algorithm specified by EncryptionAlgorithm. 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 control is agnostic of the payload that is encrypted. Any value may be encrypted. KeyId 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 (required)
Key (conditional - required for AES)
KeyPassword (conditional - required for PBES)
Certificate (conditional - required for ECDH and RSA)
ContentEncryptionAlgorithm
CompressionAlgorithm
HeaderParams
Overwrite

Input and Output Properties

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

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

InputFile
InputMessage

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

OutputFile
OutputMessage: 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 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 control 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 control 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 control 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 KeyPassword property. Set KeyPassword 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 EncryptionAlgorithm is set to Direct the Key property must be set to a valid symmetric key that will be used directly by the ContentEncryptionAlgorithm. 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 ContentEncryptionAlgorithm. 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 InputMessage or InputFile 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	KeyPassword

If the correct Key or Certificate is not known ahead of time the KeyId parameter of the RecipientInfo 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 or file specified by OutputFile and the HeaderParams property will contain the headers. Headers of the parsed message are also available through the HeaderParam event.

The following properties are applicable when calling this method:

Certificate (conditional - required for RSA and ECDH)
Key (conditional - required for AES)
ContentEncryptionAlgorithm (only if StrictValidation is True)
EncryptionAlgorithm (only if StrictValidation is True)
HeaderParams
Overwrite
StrictValidation

Input and Output Properties

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

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

InputFile
InputMessage

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

OutputFile
OutputMessage: 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 control 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 control 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 KeyPassword property. Set KeyPassword 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 ContentEncryptionAlgorithm. For instance:

Other Functionality

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

Adding custom header parameters with AddHeaderParam
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 control with short descriptions. Click on the links for further details.


CertEffectiveDate	The date on which this certificate becomes valid.
CertExpirationDate	The date on which the certificate expires.
CertExtendedKeyUsage	A comma-delimited list of extended key usage identifiers.
CertFingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
CertFingerprintSHA1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
CertFingerprintSHA256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
CertIssuer	The issuer of the certificate.
CertPrivateKey	The private key of the certificate (if available).
CertPrivateKeyAvailable	Whether a PrivateKey is available for the selected certificate.
CertPrivateKeyContainer	The name of the PrivateKey container for the certificate (if available).
CertPublicKey	The public key of the certificate.
CertPublicKeyAlgorithm	The textual description of the certificate's public key algorithm.
CertPublicKeyLength	The length of the certificate's public key (in bits).
CertSerialNumber	The serial number of the certificate encoded as a string.
CertSignatureAlgorithm	The text description of the certificate's signature algorithm.
CertStore	The name of the certificate store for the client certificate.
CertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
CertStoreType	The type of certificate store for this certificate.
CertSubjectAltNames	Comma-separated lists of alternative subject names for the certificate.
CertThumbprintMD5	The MD5 hash of the certificate.
CertThumbprintSHA1	The SHA-1 hash of the certificate.
CertThumbprintSHA256	The SHA-256 hash of the certificate.
CertUsage	The text description of UsageFlags .
CertUsageFlags	The flags that show intended use for the certificate.
CertVersion	The certificate's version number.
CertSubject	The subject of the certificate used for client authentication.
CertEncoded	The certificate (PEM/Base64 encoded).
ContentEncryptionAlgorithm	The algorithm used to encrypt the content.
EncryptionAlgorithm	The key encryption algorithm.
HeaderParamCount	The number of records in the HeaderParam arrays.
HeaderParamDataType	The data type of the header parameter.
HeaderParamName	The header parameter name.
HeaderParamValue	The header parameter value.
InputFile	The file to process.
InputMessage	The message to process.
Key	The secret key for the AES algorithm.
KeyId	The Id of the key used to encrypt the message.
KeyPassword	The key password used in the PBES algorithm.
OutputFile	The output file when encrypting or decrypting.
OutputMessage	The output message after processing.
Overwrite	Indicates whether or not the control should overwrite files.

Method List

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


AddHeaderParam	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 control.

Event List

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


Error	Fired when information is available about errors during data delivery.
HeaderParam	Fires once for each JOSE header parameter.
RecipientInfo	Fired with information about the recipient key of the encrypted message.

Config Settings

The following is a list of config settings for the control 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.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

CertEffectiveDate Property (JWE Control)

The date on which this certificate becomes valid.

Syntax

jwecontrol.CertEffectiveDate

Default Value

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

CertExpirationDate Property (JWE Control)

The date on which the certificate expires.

Syntax

jwecontrol.CertExpirationDate

Default Value

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

CertExtendedKeyUsage Property (JWE Control)

A comma-delimited list of extended key usage identifiers.

Syntax

jwecontrol.CertExtendedKeyUsage

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertFingerprint Property (JWE Control)

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

Syntax

jwecontrol.CertFingerprint

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

CertFingerprintSHA1 Property (JWE Control)

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

Syntax

jwecontrol.CertFingerprintSHA1

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

CertFingerprintSHA256 Property (JWE Control)

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

Syntax

jwecontrol.CertFingerprintSHA256

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

CertIssuer Property (JWE Control)

The issuer of the certificate.

Syntax

jwecontrol.CertIssuer

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertPrivateKey Property (JWE Control)

The private key of the certificate (if available).

Syntax

jwecontrol.CertPrivateKey

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (JWE Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

jwecontrol.CertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (JWE Control)

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

Syntax

jwecontrol.CertPrivateKeyContainer

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertPublicKey Property (JWE Control)

The public key of the certificate.

Syntax

jwecontrol.CertPublicKey

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertPublicKeyAlgorithm Property (JWE Control)

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

Syntax

jwecontrol.CertPublicKeyAlgorithm

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertPublicKeyLength Property (JWE Control)

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

Syntax

jwecontrol.CertPublicKeyLength

Default Value

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 (JWE Control)

The serial number of the certificate encoded as a string.

Syntax

jwecontrol.CertSerialNumber

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertSignatureAlgorithm Property (JWE Control)

The text description of the certificate's signature algorithm.

Syntax

jwecontrol.CertSignatureAlgorithm

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertStore Property (JWE Control)

The name of the certificate store for the client certificate.

Syntax

jwecontrol.CertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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


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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.

Data Type

Binary String

CertStorePassword Property (JWE Control)

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

Syntax

jwecontrol.CertStorePassword[=string]

Default Value

Remarks

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

Data Type

String

CertStoreType Property (JWE Control)

The type of certificate store for this certificate.

Syntax

jwecontrol.CertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

Remarks

The type of certificate store for this certificate.

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


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 control. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword 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.

Data Type

Integer

CertSubjectAltNames Property (JWE Control)

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

Syntax

jwecontrol.CertSubjectAltNames

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (JWE Control)

The MD5 hash of the certificate.

Syntax

jwecontrol.CertThumbprintMD5

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (JWE Control)

The SHA-1 hash of the certificate.

Syntax

jwecontrol.CertThumbprintSHA1

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (JWE Control)

The SHA-256 hash of the certificate.

Syntax

jwecontrol.CertThumbprintSHA256

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertUsage Property (JWE Control)

The text description of UsageFlags .

Syntax

jwecontrol.CertUsage

Default Value

Remarks

The text description of CertUsageFlags.

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 (JWE Control)

The flags that show intended use for the certificate.

Syntax

jwecontrol.CertUsageFlags

Default Value

Remarks

The flags that show intended use for the certificate. The value of CertUsageFlags 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 property for a text representation of CertUsageFlags.

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

This property is read-only.

Data Type

Integer

CertVersion Property (JWE Control)

The certificate's version number.

Syntax

jwecontrol.CertVersion

Default Value

Remarks

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

This property is read-only.

Data Type

String

CertSubject Property (JWE Control)

The subject of the certificate used for client authentication.

Syntax

jwecontrol.CertSubject[=string]

Default Value

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

Data Type

String

CertEncoded Property (JWE Control)

The certificate (PEM/Base64 encoded).

Syntax

jwecontrol.CertEncoded[=string]

Default Value

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.

This property is not available at design time.

Data Type

Binary String

ContentEncryptionAlgorithm Property (JWE Control)

The algorithm used to encrypt the content.

Syntax

jwecontrol.ContentEncryptionAlgorithm[=integer]

Possible Values

ceaA128CBC_HS256(0), 
ceaA192CBC_HS384(1), 
ceaA256CBC_HS512(2), 
ceaA128GCM(3), 
ceaA192GCM(4), 
ceaA256GCM(5)

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

Data Type

Integer

EncryptionAlgorithm Property (JWE Control)

The key encryption algorithm.

Syntax

jwecontrol.EncryptionAlgorithm[=integer]

Possible Values

eaRSA1_5(0), 
eaRSA_OAEP(1), 
eaRSA_OAEP_256(2), 
eaA128KW(3), 
eaA192KW(4), 
eaA256KW(5), 
eaDir(6), 
eaECDH_ES(7), 
eaECDH_ES_A128KW(8), 
eaECDH_ES_A192KW(9), 
eaECDH_ES_A256KW(10), 
eaA128GCMKW(11), 
eaA192GCMKW(12), 
eaA256GCMKW(13), 
eaPBES2_HS256_A128KW(14), 
eaPBES2_HS384_A192KW(15), 
eaPBES2_HS512_A256KW(16)

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 KeyPassword 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
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	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
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	KeyPassword
15 (eaPBES2_HS384_A192KW)	PBES2 with HMAC SHA-384 and A192KW	KeyPassword
16 (eaPBES2_HS512_A256KW)	PBES2 with HMAC SHA-512 and A256KW	KeyPassword

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

Data Type

Integer

HeaderParamCount Property (JWE Control)

The number of records in the HeaderParam arrays.

Syntax

jwecontrol.HeaderParamCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

HeaderParamDataType
HeaderParamName
HeaderParamValue

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

This property is not available at design time.

Data Type

Integer

HeaderParamDataType Property (JWE Control)

The data type of the header parameter.

Syntax

jwecontrol.HeaderParamDataType(HeaderParamIndex)[=integer]

Possible Values

dtObject(0), 
dtArray(1), 
dtString(2), 
dtNumber(3), 
dtBool(4), 
dtNull(5)

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

This property is not available at design time.

Data Type

Integer

HeaderParamName Property (JWE Control)

The header parameter name.

Syntax

jwecontrol.HeaderParamName(HeaderParamIndex)[=string]

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

This property is not available at design time.

Data Type

String

HeaderParamValue Property (JWE Control)

The header parameter value.

Syntax

jwecontrol.HeaderParamValue(HeaderParamIndex)[=string]

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

This property is not available at design time.

Data Type

String

InputFile Property (JWE Control)

The file to process.

Syntax

jwecontrol.InputFile[=string]

Default Value

Remarks

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

Input and Output Properties

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

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

InputFile
InputMessage

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

OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

InputMessage Property (JWE Control)

The message to process.

Syntax

jwecontrol.InputMessage[=string]

Default Value

Remarks

This property specifies the message to be processed.

Input and Output Properties

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

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

InputFile
InputMessage

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

OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .InputMessageB.

Data Type

Binary String

Key Property (JWE Control)

The secret key for the AES algorithm.

Syntax

jwecontrol.Key[=string]

Default Value

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyB.

Data Type

Binary String

KeyId Property (JWE Control)

The Id of the key used to encrypt the message.

Syntax

jwecontrol.KeyId[=string]

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.

Data Type

String

KeyPassword Property (JWE Control)

The key password used in the PBES algorithm.

Syntax

jwecontrol.KeyPassword[=string]

Default Value

Remarks

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

This is only applicable to PBES algorithms and must be set before calling Encrypt or Decrypt.

Data Type

String

OutputFile Property (JWE Control)

The output file when encrypting or decrypting.

Syntax

jwecontrol.OutputFile[=string]

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 control will determine the source and destination of the input and output based on which properties are set.

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

InputFile
InputMessage

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

OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

OutputMessage Property (JWE Control)

The output message after processing.

Syntax

jwecontrol.OutputMessage

Default Value

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

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

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

InputFile
InputMessage

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

OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .OutputMessageB.

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

Data Type

Binary String

Overwrite Property (JWE Control)

Indicates whether or not the control should overwrite files.

Syntax

jwecontrol.Overwrite[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

AddHeaderParam Method (JWE Control)

Adds additional header parameters.

Syntax

jwecontrol.AddHeaderParam name, value, dataType

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

Parameters Automatically Set:


Header Param	Property
`alg`	EncryptionAlgorithm
`enc`	ContentEncryptionAlgorithm
`kid`	KeyId
`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 (JWE Control)

Sets or retrieves a configuration setting.

Syntax

jwecontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

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

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

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (JWE Control)

Decrypts the payload.

Syntax

jwecontrol.Decrypt

Remarks

This method decrypts the input data.

Before calling the Decrypt method set InputMessage or InputFile 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	KeyPassword

If the correct Key or Certificate is not known ahead of time the KeyId parameter of the RecipientInfo 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)
ContentEncryptionAlgorithm (only if StrictValidation is True)
EncryptionAlgorithm (only if StrictValidation is True)
HeaderParams
Overwrite
StrictValidation

Input and Output Properties

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

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

InputFile
InputMessage

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

OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.