JWE Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipcJWE

Remarks

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

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 component 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 component the PEM encoded PublicKey may be used directly with the Certificate property. An example PEM encoded public certificate created by the ECC component:

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

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

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:

AlgorithmPrivate Key Location
AESKey
RSA and ECDHCertificate
PBESKeyPassword
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 raises an exception. 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:

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

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

CertificateThe certificate used for encryption or decryption.
ContentEncryptionAlgorithmThe algorithm used to encrypt the content.
EncryptionAlgorithmThe key encryption algorithm.
HeaderParamsThe JOSE header parameters.
InputFileThe file to process.
InputMessageThe message to process.
KeyThe secret key for the AES algorithm.
KeyIdThe Id of the key used to encrypt the message.
KeyPasswordThe key password used in the PBES algorithm.
OutputFileThe output file when encrypting or decrypting.
OutputMessageThe output message after processing.
OverwriteIndicates whether or not the component should overwrite files.

Method List

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

AddHeaderParamAdds additional header parameters.
ConfigSets or retrieves a configuration setting.
DecryptDecrypts the payload.
EncryptEncrypts the payload with the specified algorithms.
ParseParses the compact serialized JWE string.
ResetResets the component.
SetInputStreamSets the stream from which the component will read data.
SetOutputStreamSets the stream to which the component will write data.

Event List

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

ErrorFired when information is available about errors during data delivery.
HeaderParamFires once for each JOSE header parameter.
RecipientInfoFired with information about the recipient key of the encrypted message.

Config Settings

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

CompressionAlgorithmThe compression algorithm to use.
PartyUInfoInformation about the producer of the message.
PartyVInfoInformation about the recipient of the message.
PBES2CountThe PBKDF2 iteration count.
PBES2SaltLengthThe salt input value length.
RawHeaderHolds the raw JOSE header.
StrictValidationRequires specific algorithm when decrypting.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseFIPSCompliantAPITells the component whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Certificate Property (JWE Component)

The certificate used for encryption or decryption.

Syntax

property Certificate: TipcCertificate read get_Certificate write set_Certificate;

Remarks

This property specifies a certificate for encryption or decryption.

When calling Encrypt and EncryptionAlgorithm is set to an RSA or ECDH algorithm this property must be set to a public certificate of the recipient.

When calling Decrypt and the message was encrypted using an RSA or ECDH EncryptionAlgorithm this property specifies the certificate with private key used to decrypt the message.

Please refer to the Certificate type for a complete list of fields.

ContentEncryptionAlgorithm Property (JWE Component)

The algorithm used to encrypt the content.

Syntax

property ContentEncryptionAlgorithm: TipcTContentEncryptionAlgorithms read get_ContentEncryptionAlgorithm write set_ContentEncryptionAlgorithm;

TipcTContentEncryptionAlgorithms = (
  ceaA128CBC_HS256,
  ceaA192CBC_HS384,
  ceaA256CBC_HS512,
  ceaA128GCM,
  ceaA192GCM,
  ceaA256GCM
);

Default Value

ceaA128CBC_HS256

Remarks

This property specifies the algorithm used to encrypt the content.

The following values are supported.

AlgorithmDescription
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

EncryptionAlgorithm Property (JWE Component)

The key encryption algorithm.

Syntax

property EncryptionAlgorithm: TipcTEncryptionAlgorithms read get_EncryptionAlgorithm write set_EncryptionAlgorithm;

TipcTEncryptionAlgorithms = (
  eaRSA1_5,
  eaRSA_OAEP,
  eaRSA_OAEP_256,
  eaA128KW,
  eaA192KW,
  eaA256KW,
  eaDir,
  eaECDH_ES,
  eaECDH_ES_A128KW,
  eaECDH_ES_A192KW,
  eaECDH_ES_A256KW,
  eaA128GCMKW,
  eaA192GCMKW,
  eaA256GCMKW,
  eaPBES2_HS256_A128KW,
  eaPBES2_HS384_A192KW,
  eaPBES2_HS512_A256KW
);

Default Value

eaRSA1_5

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:

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

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

HeaderParams Property (JWE Component)

The JOSE header parameters.

Syntax

property HeaderParams: TipcHeaderParamList read get_HeaderParams write set_HeaderParams;

Remarks

This property specifies the JOSE header parameters. This may be populated before calling Sign or Encrypt. This is populated with the parsed header values after calling Verify, Decrypt, or Parse.

This property is not available at design time.

Please refer to the HeaderParam type for a complete list of fields.

InputFile Property (JWE Component)

The file to process.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

InputMessage Property (JWE Component)

The message to process.

Syntax

property InputMessage: String read get_InputMessage write set_InputMessage;
property InputMessageB: TBytes read get_InputMessageB write set_InputMessageB;

Default Value

''

Remarks

This property specifies the message to be processed.

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Key Property (JWE Component)

The secret key for the AES algorithm.

Syntax

property Key: String read get_Key write set_Key;
property KeyB: TBytes read get_KeyB write set_KeyB;

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.

KeyId Property (JWE Component)

The Id of the key used to encrypt the message.

Syntax

property KeyId: String read get_KeyId write set_KeyId;

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.

KeyPassword Property (JWE Component)

The key password used in the PBES algorithm.

Syntax

property KeyPassword: String read get_KeyPassword write set_KeyPassword;

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.

OutputFile Property (JWE Component)

The output file when encrypting or decrypting.

Syntax

property OutputFile: String read get_OutputFile write set_OutputFile;

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

OutputMessage Property (JWE Component)

The output message after processing.

Syntax

property OutputMessage: String read get_OutputMessage;
property OutputMessageB: TBytes read get_OutputMessageB;

Default Value

''

Remarks

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

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

Overwrite Property (JWE Component)

Indicates whether or not the component should overwrite files.

Syntax

property Overwrite: Boolean read get_Overwrite write set_Overwrite;

Default Value

false

Remarks

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

AddHeaderParam Method (JWE Component)

Adds additional header parameters.

Syntax

procedure AddHeaderParam(name: String; value: String; dataType: Integer);

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

Parameters Automatically Set:

Header ParamProperty
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 Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Decrypts the payload.

Syntax

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

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:

AlgorithmPrivate Key Location
AESKey
RSA and ECDHCertificate
PBESKeyPassword
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 raises an exception. 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:

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

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

Encrypts the payload with the specified algorithms.

Syntax

procedure Encrypt();

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. 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 component 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:

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 component 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 component the PEM encoded PublicKey may be used directly with the Certificate property. An example PEM encoded public certificate created by the ECC component:

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

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

Parse Method (JWE Component)

Parses the compact serialized JWE string.

Syntax

procedure Parse();

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

When calling this method the headers are parsed. The HeaderParam and RecipientInfo events will fire and the HeaderParams property will be populated.

Reset Method (JWE Component)

Resets the component.

Syntax

procedure Reset();

Remarks

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

SetInputStream Method (JWE Component)

Sets the stream from which the component will read data.

Syntax

procedure SetInputStream(InputStream: TStream);

Remarks

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

Input and Output Properties

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

SetOutputStream Method (JWE Component)

Sets the stream to which the component will write data.

Syntax

procedure SetOutputStream(OutputStream: TStream);

Remarks

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

Input and Output Properties

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

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

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

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Error Event (JWE Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

HeaderParam Event (JWE Component)

Fires once for each JOSE header parameter.

Syntax

type THeaderParamEvent = procedure (
  Sender: TObject;
  const Name: String;
  const Value: String;
  DataType: Integer
) of Object;

property OnHeaderParam: THeaderParamEvent read FOnHeaderParam write FOnHeaderParam;

Remarks

When Decrypt or Parse 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 (JWE Component)

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

Syntax

type TRecipientInfoEvent = procedure (
  Sender: TObject;
  const KeyId: String;
  const Algorithm: String
) of Object;

property OnRecipientInfo: TRecipientInfoEvent read FOnRecipientInfo write FOnRecipientInfo;

Remarks

This event fires with information about the key used to encrypt the data. This may be used to help identify the Key or Certificate to load in order to decrypt the message. This event fires when Decrypt or Parse is called.

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

Algorithm is the encryption algorithm used to encrypt the data.

Certificate Type

This is the digital certificate being used.

Remarks

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

The following fields are available:
  • EffectiveDate
  • ExpirationDate
  • ExtendedKeyUsage
  • Fingerprint
  • FingerprintSHA1
  • FingerprintSHA256
  • Issuer
  • PrivateKey
  • PrivateKeyAvailable
  • PrivateKeyContainer
  • PublicKey
  • PublicKeyAlgorithm
  • PublicKeyLength
  • SerialNumber
  • SignatureAlgorithm
  • Store
  • StorePassword
  • StoreType
  • SubjectAltNames
  • ThumbprintMD5
  • ThumbprintSHA1
  • ThumbprintSHA256
  • Usage
  • UsageFlags
  • Version
  • Subject
  • Encoded

    • Fields

    EffectiveDate
    String (read-only)
    Default Value: ""

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

    23-Jan-2000 15:00:00.

    ExpirationDate
    String (read-only)
    Default Value: ""

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

    23-Jan-2001 15:00:00.

    ExtendedKeyUsage
    String (read-only)
    Default Value: ""

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

    Fingerprint
    String (read-only)
    Default Value: ""

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

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

    FingerprintSHA1
    String (read-only)
    Default Value: ""

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

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

    FingerprintSHA256
    String (read-only)
    Default Value: ""

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

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

    Issuer
    String (read-only)
    Default Value: ""

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

    PrivateKey
    String (read-only)
    Default Value: ""

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

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

    PrivateKeyAvailable
    Boolean (read-only)
    Default Value: False

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

    PrivateKeyContainer
    String (read-only)
    Default Value: ""

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

    PublicKey
    String (read-only)
    Default Value: ""

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

    PublicKeyAlgorithm
    String (read-only)
    Default Value: ""

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

    PublicKeyLength
    Integer (read-only)
    Default Value: 0

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

    SerialNumber
    String (read-only)
    Default Value: ""

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

    SignatureAlgorithm
    String (read-only)
    Default Value: ""

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

    Store
    String
    Default Value: "MY"

    The name of the certificate store for the client certificate.

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

    Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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:

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot certificates.

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

    StoreB
    TBytes
    Default Value: "MY"

    The name of the certificate store for the client certificate.

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

    Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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:

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot certificates.

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

    StorePassword
    String
    Default Value: ""

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

    StoreType
    TipcCertStoreTypes
    Default Value: 0

    The type of certificate store for this certificate.

    The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component 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 component. 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 Store and set StorePassword 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.

    SubjectAltNames
    String (read-only)
    Default Value: ""

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

    ThumbprintMD5
    String (read-only)
    Default Value: ""

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

    ThumbprintSHA1
    String (read-only)
    Default Value: ""

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

    ThumbprintSHA256
    String (read-only)
    Default Value: ""

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

    Usage
    String (read-only)
    Default Value: ""

    The text description of UsageFlags.

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

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

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

    UsageFlags
    Integer (read-only)
    Default Value: 0

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

    0x80Digital Signature
    0x40Non-Repudiation
    0x20Key Encipherment
    0x10Data Encipherment
    0x08Key Agreement
    0x04Certificate Signing
    0x02CRL Signing
    0x01Encipher Only

    Please see the Usage property for a text representation of UsageFlags.

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

    Version
    String (read-only)
    Default Value: ""

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

    Subject
    String
    Default Value: ""

    The subject of the certificate used for client authentication.

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

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

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

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

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

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

    FieldMeaning
    CNCommon Name. This is commonly a hostname like www.server.com.
    OOrganization
    OUOrganizational Unit
    LLocality
    SState
    CCountry
    EEmail Address

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

    Encoded
    String
    Default Value: ""

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

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

    EncodedB
    TBytes
    Default Value: ""

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

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

    Constructors

    > 

    constructor Create();

    Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

    > 
    constructor Create(valEncoded: TBytes);

    Parses Encoded as an X.509 public key.

    > 
    constructor Create(valStoreType: TipcCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

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

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

    > 
    constructor Create(valStoreType: TipcCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

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

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

    HeaderParam Type

    The JOSE header parameter.

    Remarks

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

    The following fields are available:
  • DataType
  • Name
  • Value

    • Fields

    DataType
    TipcTDataTypes
    Default Value: 2

    The data type of the header parameter.

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

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

    Name
    String
    Default Value: ""

    The header parameter name.

    Value
    String
    Default Value: ""

    The header parameter value.

    Constructors

    > 

    constructor Create();

    Creates a new header parameter with no name or value.

    > 
    constructor Create(valName: String; valValue: String);

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

    Config Settings (JWE Component)

    The component 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 component, access to these internal properties is provided through the Config 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. When calling Decrypt this setting is populated and also accessible from within the RecipientInfo 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:

    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. When calling Decrypt this setting is populated and also accessible from within the RecipientInfo 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:

    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 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 is set to a PBES algorithm.

    RawHeader:   Holds the raw JOSE header.

    This setting may be queried after calling Encrypt or Decrypt 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 component will validate the that algorithms used in the JWE message match the values specified in EncryptionAlgorithm and ContentEncryptionAlgorithm. If either algorithms do not match the component raises an exception.

    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:

    IdentifierName
    037IBM EBCDIC - U.S./Canada
    437OEM - United States
    500IBM EBCDIC - International
    708Arabic - ASMO 708
    709Arabic - ASMO 449+, BCON V4
    710Arabic - Transparent Arabic
    720Arabic - Transparent ASMO
    737OEM - Greek (formerly 437G)
    775OEM - Baltic
    850OEM - Multilingual Latin I
    852OEM - Latin II
    855OEM - Cyrillic (primarily Russian)
    857OEM - Turkish
    858OEM - Multilingual Latin I + Euro symbol
    860OEM - Portuguese
    861OEM - Icelandic
    862OEM - Hebrew
    863OEM - Canadian-French
    864OEM - Arabic
    865OEM - Nordic
    866OEM - Russian
    869OEM - Modern Greek
    870IBM EBCDIC - Multilingual/ROECE (Latin-2)
    874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
    875IBM EBCDIC - Modern Greek
    932ANSI/OEM - Japanese, Shift-JIS
    936ANSI/OEM - Simplified Chinese (PRC, Singapore)
    949ANSI/OEM - Korean (Unified Hangul Code)
    950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
    1026IBM EBCDIC - Turkish (Latin-5)
    1047IBM EBCDIC - Latin 1/Open System
    1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
    1141IBM EBCDIC - Germany (20273 + Euro symbol)
    1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
    1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
    1144IBM EBCDIC - Italy (20280 + Euro symbol)
    1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
    1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
    1147IBM EBCDIC - France (20297 + Euro symbol)
    1148IBM EBCDIC - International (500 + Euro symbol)
    1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
    1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
    1201Unicode UCS-2 Big-Endian
    1250ANSI - Central European
    1251ANSI - Cyrillic
    1252ANSI - Latin I
    1253ANSI - Greek
    1254ANSI - Turkish
    1255ANSI - Hebrew
    1256ANSI - Arabic
    1257ANSI - Baltic
    1258ANSI/OEM - Vietnamese
    1361Korean (Johab)
    10000MAC - Roman
    10001MAC - Japanese
    10002MAC - Traditional Chinese (Big5)
    10003MAC - Korean
    10004MAC - Arabic
    10005MAC - Hebrew
    10006MAC - Greek I
    10007MAC - Cyrillic
    10008MAC - Simplified Chinese (GB 2312)
    10010MAC - Romania
    10017MAC - Ukraine
    10021MAC - Thai
    10029MAC - Latin II
    10079MAC - Icelandic
    10081MAC - Turkish
    10082MAC - Croatia
    12000Unicode UCS-4 Little-Endian
    12001Unicode UCS-4 Big-Endian
    20000CNS - Taiwan
    20001TCA - Taiwan
    20002Eten - Taiwan
    20003IBM5550 - Taiwan
    20004TeleText - Taiwan
    20005Wang - Taiwan
    20105IA5 IRV International Alphabet No. 5 (7-bit)
    20106IA5 German (7-bit)
    20107IA5 Swedish (7-bit)
    20108IA5 Norwegian (7-bit)
    20127US-ASCII (7-bit)
    20261T.61
    20269ISO 6937 Non-Spacing Accent
    20273IBM EBCDIC - Germany
    20277IBM EBCDIC - Denmark/Norway
    20278IBM EBCDIC - Finland/Sweden
    20280IBM EBCDIC - Italy
    20284IBM EBCDIC - Latin America/Spain
    20285IBM EBCDIC - United Kingdom
    20290IBM EBCDIC - Japanese Katakana Extended
    20297IBM EBCDIC - France
    20420IBM EBCDIC - Arabic
    20423IBM EBCDIC - Greek
    20424IBM EBCDIC - Hebrew
    20833IBM EBCDIC - Korean Extended
    20838IBM EBCDIC - Thai
    20866Russian - KOI8-R
    20871IBM EBCDIC - Icelandic
    20880IBM EBCDIC - Cyrillic (Russian)
    20905IBM EBCDIC - Turkish
    20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
    20932JIS X 0208-1990 & 0121-1990
    20936Simplified Chinese (GB2312)
    21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
    21027Extended Alpha Lowercase
    21866Ukrainian (KOI8-U)
    28591ISO 8859-1 Latin I
    28592ISO 8859-2 Central Europe
    28593ISO 8859-3 Latin 3
    28594ISO 8859-4 Baltic
    28595ISO 8859-5 Cyrillic
    28596ISO 8859-6 Arabic
    28597ISO 8859-7 Greek
    28598ISO 8859-8 Hebrew
    28599ISO 8859-9 Latin 5
    28605ISO 8859-15 Latin 9
    29001Europa 3
    38598ISO 8859-8 Hebrew
    50220ISO 2022 Japanese with no halfwidth Katakana
    50221ISO 2022 Japanese with halfwidth Katakana
    50222ISO 2022 Japanese JIS X 0201-1989
    50225ISO 2022 Korean
    50227ISO 2022 Simplified Chinese
    50229ISO 2022 Traditional Chinese
    50930Japanese (Katakana) Extended
    50931US/Canada and Japanese
    50933Korean Extended and Korean
    50935Simplified Chinese Extended and Simplified Chinese
    50936Simplified Chinese
    50937US/Canada and Traditional Chinese
    50939Japanese (Latin) Extended and Japanese
    51932EUC - Japanese
    51936EUC - Simplified Chinese
    51949EUC - Korean
    51950EUC - Traditional Chinese
    52936HZ-GB2312 Simplified Chinese
    54936Windows XP: GB18030 Simplified Chinese (4 Byte)
    57002ISCII Devanagari
    57003ISCII Bengali
    57004ISCII Tamil
    57005ISCII Telugu
    57006ISCII Assamese
    57007ISCII Oriya
    57008ISCII Kannada
    57009ISCII Malayalam
    57010ISCII Gujarati
    57011ISCII Punjabi
    65000Unicode UTF-7
    65001Unicode UTF-8
    The following is a list of valid code page identifiers for Mac OS only:
    IdentifierName
    1ASCII
    2NEXTSTEP
    3JapaneseEUC
    4UTF8
    5ISOLatin1
    6Symbol
    7NonLossyASCII
    8ShiftJIS
    9ISOLatin2
    10Unicode
    11WindowsCP1251
    12WindowsCP1252
    13WindowsCP1253
    14WindowsCP1254
    15WindowsCP1250
    21ISO2022JP
    30MacOSRoman
    10UTF16String
    0x90000100UTF16BigEndian
    0x94000100UTF16LittleEndian
    0x8c000100UTF32String
    0x98000100UTF32BigEndian
    0x9c000100UTF32LittleEndian
    65536Proprietary

    LicenseInfo:   Information about the current license.

    When queried, this setting will return a string containing information about the license this instance of a component 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.

    This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

    UseFIPSCompliantAPI:   Tells the component whether or not to use FIPS certified APIs.

    When set to True, the component 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 components 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 article.

    Note: This setting is applicable only on Windows.

    Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

    UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

    When set to False, the component will use the system security libraries by default to perform cryptographic functions where applicable.

    Setting this configuration setting to True tells the component to use the internal implementation instead of using the system security libraries.

    This setting is set to False by default on all platforms.

    Trappable Errors (JWE Component)

    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.