Jwe

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Returns the number of recipients represented by the currently loaded or configured JWE. Recipient indexes are zero-based, from 0 through NumRecipients - 1.

Compact Serialization and Flattened JWE JSON Serialization represent one recipient. General JWE JSON Serialization can represent one or more recipients that share the same encrypted payload while using separate recipient key-management information.

Controls whether encryption prefers JWE Compact Serialization. The default is true. When true, compact form is used whenever the configured JWE can be represented by its five period-separated base64url segments.

JWE JSON Serialization is required instead when the message has multiple recipients, a shared unprotected header, a recipient-specific unprotected header, or external Additional Authenticated Data. Setting this property to false requests JSON serialization even when compact form would otherwise be possible.

Controls which JWE JSON Serialization is preferred when JSON form is used. The default is true.

• When true and there is exactly one recipient, Chilkat prefers Flattened JWE JSON Serialization.
• When false, Chilkat may use General JWE JSON Serialization even for one recipient.
• When multiple recipients exist, General JWE JSON Serialization is required regardless of this setting.

This property has no effect when Compact Serialization is selected.

Provides a catch-all string for specialized compatibility options that are not exposed as ordinary properties. The default is the empty string, which is appropriate for normal JWE creation and decryption.

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Decrypts the previously loaded JWE for recipient index index and returns the plaintext as a string. charset specifies how the authenticated plaintext bytes are decoded into characters, such as utf-8. Use DecryptBd when the plaintext is binary or when no character decoding is desired.

Call LoadJwe or LoadJweSb first, then provide the key material required by the selected recipient's alg value through SetPrivateKey, SetWrappingKey, or SetPassword. For a single-recipient JWE, index is normally 0.

Returns null on failure

Decrypts the previously loaded JWE for recipient index index and appends the authenticated plaintext bytes to the BinData object in bd. No character-set conversion is performed.

This is the preferred decryption method for arbitrary binary content. For a typical single-recipient JWE, index is 0. Set the corresponding private key, symmetric key, or PBES2 password before calling this method.

Returns true for success, false for failure.

Decrypts the previously loaded JWE for recipient index index, decodes the authenticated plaintext bytes using the character encoding in charset, and appends the resulting text to contentSb. For a typical single-recipient JWE, index is 0.

Set the required private key, wrapping key, direct key, or password at the same recipient index before calling this method.

Returns true for success, false for failure.

Encrypts the string in content and returns the resulting JWE serialization. charset specifies the character encoding used to convert the string to plaintext bytes, such as utf-8. Use EncryptBd when the plaintext is already binary data.

Before calling this method, set a protected header containing the required alg and enc values, then provide the corresponding recipient key or password. The output format is selected by PreferCompact and PreferFlattened, subject to the structural requirements of the JWE.

Returns null on failure

Encrypts the exact bytes contained in contentBd and appends the resulting JWE text to jweSb. This method performs no character-set conversion and is therefore appropriate for files, compressed data, serialized objects, or any other binary plaintext.

Configure the protected header and the recipient key-management material before calling this method. The JWE ciphertext is base64url-encoded as required by the selected serialization.

Returns true for success, false for failure.

Encrypts the text currently contained in contentSb. charset specifies the character encoding used to convert that text to plaintext bytes. The resulting JWE text is appended to jweSb; existing content in jweSb is preserved.

Configure the protected header, recipient keys, optional unprotected headers, and optional Additional Authenticated Data before calling this method. Serialization selection follows PreferCompact and PreferFlattened.

Returns true for success, false for failure.

Searches the loaded JWE's recipient header information for a parameter named paramName whose value equals paramValue. Returns the zero-based recipient index of the first match, or -1 when no match is found. caseSensitive controls whether both the parameter-name and parameter-value comparisons are case-sensitive.

The most common lookup parameter is kid, an application-defined key identifier. A typical multi-recipient workflow is:

1. Load the JWE.
2. Call this method to locate the recipient whose kid identifies an available key.
3. Set that key or password at the returned index.
4. Decrypt using the same index.

Loads the decoded JSON header exposed by the currently loaded JWE into json. Use this method for general header inspection. Use GetProtectedHeader when the application specifically needs the shared protected-header members.

A JWE header can contain values such as alg, enc, kid, cty, zip, and algorithm-specific parameters. Header values are visible without decrypting the ciphertext.

Returns true for success, false for failure.

Loads the decoded shared JWE Protected Header into json. This is the JSON object that was base64url-encoded into the compact serialization's first segment or stored in the JSON serialization's protected member.

The protected header commonly contains alg and enc, along with other security-sensitive parameters. It is authenticated as part of the JWE but is not encrypted.

Returns true for success, false for failure.

Parses the JWE serialization in jwe and loads it into this object. Compact Serialization, Flattened JWE JSON Serialization, and General JWE JSON Serialization are accepted.

Loading separates and decodes the JWE structure so that properties and methods such as NumRecipients, FindRecipient, GetHeader, and GetProtectedHeader can be used. It does not decrypt the ciphertext and does not require a key.

Returns true for success, false for failure.

Parses and loads a JWE from the complete text contained in sb. It accepts compact, flattened JSON, or general JSON serialization and otherwise behaves the same as LoadJwe.

Loading prepares the object for header inspection, recipient selection, and decryption; it does not decrypt or authenticate the message.

Returns true for success, false for failure.

Sets optional external Additional Authenticated Data (AAD) from the string in aad. charset specifies the character encoding used to convert the string to bytes.

AAD is not encrypted and is not part of the plaintext, but it is covered by the JWE authentication tag. In JWE JSON Serialization, its base64url representation is carried in the aad member. Any change to those bytes causes decryption to fail. External AAD cannot be represented in Compact Serialization, so setting it requires JSON Serialization.

Returns true for success, false for failure.

Sets optional external Additional Authenticated Data (AAD) to the exact bytes contained in aad. This method is the binary equivalent of SetAad and performs no character-set conversion.

The AAD is transmitted without encryption in the JSON serialization's aad member, but it is authenticated together with the protected header and ciphertext. External AAD is available only in JWE JSON Serialization and therefore prevents Compact Serialization.

Returns true for success, false for failure.

Sets the password used for PBES2 key management for the recipient at zero-based index index. Use this method when the JWE alg value is one of the following:

• PBES2-HS256+A128KW
• PBES2-HS384+A192KW
• PBES2-HS512+A256KW

PBES2 derives a key-encryption key from the password and then uses AES Key Wrap to protect the content-encryption key. For encryption, the protected header must also contain p2s, a base64url-encoded random salt input, and p2c, the iteration count. For decryption, those values are read from the loaded JWE.

Returns true for success, false for failure.

Sets the private key used to decrypt for the recipient at zero-based index index. The required key type is determined by the recipient's alg header parameter.

For a typical single-recipient JWE, index is 0. For a multi-recipient JWE, set the private key at the same index that will be passed to Decrypt, DecryptSb, or DecryptBd.

Returns true for success, false for failure.

Sets the shared JWE Protected Header from the JSON object in json. The protected header is serialized as UTF-8 JSON, base64url-encoded, and included in the authenticated data used by the content-encryption algorithm. It is visible to recipients but cannot be changed without causing authentication to fail.

For encryption, the protected header normally contains at least alg, which selects the key-management algorithm, and enc, which selects the authenticated content-encryption algorithm. Other commonly protected parameters include kid, cty, typ, and zip.

Returns true for success, false for failure.

Sets the recipient public key used for encryption at zero-based index index. The required key type is determined by the alg parameter in the JWE header.

For a typical single-recipient JWE, index is 0. For general JSON serialization, call this method for each recipient index with that recipient's public key.

Returns true for success, false for failure.

Sets the unprotected header for the recipient at zero-based index index. Recipient index 0 is the first recipient. A recipient-specific header is represented by the header member of a flattened or general JWE JSON Serialization and cannot be represented in Compact Serialization.

This header is commonly used for recipient-specific routing metadata such as kid. It can be used for a single-recipient flattened JWE or for each recipient in a multi-recipient general JWE.

Returns true for success, false for failure.

Sets the JWE Shared Unprotected Header from json. Its members apply to every recipient and are emitted only in JWE JSON Serialization. Compact Serialization has no shared unprotected-header member.

The shared unprotected header is neither encrypted nor integrity-protected. It is appropriate only for non-security-critical metadata that must remain outside the protected header.

Returns true for success, false for failure.

Sets the symmetric key used by the recipient at zero-based index index. encodedKey contains the encoded key, and encoding names its representation, such as hex, base64, or base64url.

For dir, examples include 128, 192, or 256 bits for A128GCM, A192GCM, or A256GCM, and 256, 384, or 512 bits for A128CBC-HS256, A192CBC-HS384, or A256CBC-HS512.

Returns true for success, false for failure.