Jwe C Reference Documentation
Jwe
Current Version: 10.0.0
An API for JSON Web Encryption (JWE). Provides the ability to create (encrypt) and decrypt JWE's.
Supported Algorithms:
- RSAES OAEP 256 (using SHA-256 and MGF1 with SHA-256) encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- RSAES OAEP (using SHA-1 and MGF1 with SHA-1) encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- RSAES-PKCS1-V1_5 encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- Direct symmetric key encryption with pre-shared key A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM and A256GCM
- A128KW, A192KW, A256KW encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- A128GCMKW, A192GCMKW, A256GCMKW encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
Create/Dispose
HCkJwe instance = CkJwe_Create(); // ... CkJwe_Dispose(instance);
Creates an instance of the HCkJwe object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkJwe_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkJwe_Dispose.
Properties
DebugLogFilePath
void CkJwe_putDebugLogFilePath(HCkJwe cHandle, const char *newVal);
const char *CkJwe_debugLogFilePath(HCkJwe cHandle);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
const char *CkJwe_lastErrorHtml(HCkJwe cHandle);
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
const char *CkJwe_lastErrorText(HCkJwe cHandle);
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
const char *CkJwe_lastErrorXml(HCkJwe cHandle);
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
void CkJwe_putLastMethodSuccess(HCkJwe cHandle, BOOL newVal);
Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topNumRecipients
The number of recipients for this JWE.
topPreferCompact
void CkJwe_putPreferCompact(HCkJwe cHandle, BOOL newVal);
Controls whether the JWE Compact Serialization or JWE JSON Serialization is preferred when creating JWEs. The default value is TRUE, which is to use compact serialization when possible. If multiple recipients exist, or if any unprotected headers exist, then JWE JSON Serialization is used regardless of this property setting.
topPreferFlattened
void CkJwe_putPreferFlattened(HCkJwe cHandle, BOOL newVal);
Controls whether the flattened serialization is preferred when JWE JSON Serialization is used. The default value is TRUE, which is to use the flattened serialization when possible. If multiple recipients exist, then the general (non-flattened) JWE JSON Serialization is used regardless of this property setting.
Utf8
void CkJwe_putUtf8(HCkJwe cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkJwe_putVerboseLogging(HCkJwe cHandle, BOOL newVal);
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.
topVersion
Methods
Decrypt
const char *CkJwe_decrypt(HCkJwe cHandle, int index, const char *charset);
Decrypts a JWE and returns the original (decrypted) string content. The byte representation of the decrypted bytes is indicated by charset (such as "utf-8"). (The charset tells Chilkat how to intepret the decrypted bytes as characters.)
The index specifies which recipient key is used for decryption. (Most JWEs have only a single recipent, and thus the index is typically 0.)
Supported Algorithms:
- RSAES OAEP 256 (using SHA-256 and MGF1 with SHA-256) encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- RSAES OAEP (using SHA-1 and MGF1 with SHA-1) encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- RSAES-PKCS1-V1_5 encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- Direct symmetric key encryption with pre-shared key A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM and A256GCM
- A128KW, A192KW, A256KW encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- A128GCMKW, A192GCMKW, A256GCMKW encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
Returns TRUE for success, FALSE for failure.
DecryptBd
Decrypts the loaded JWE and appends the decrypted bytes to the contents of bd. The index specifies which recipient key is used for decryption. (Most JWEs have only a single recipent, and thus the index is typically 0.)
Returns TRUE for success, FALSE for failure.
DecryptSb
Decrypts the loaded JWE and appends the decrypted content to contentSb. The byte representation of the decrypted bytes is indicated by charset (such as "utf-8"). (This tells Chilkat how to interpret the bytes as characters.)
The index specifies which recipient key is used for decryption. (Most JWEs have only a single recipent, and thus the index is typically 0.)
Returns TRUE for success, FALSE for failure.
Encrypt
const char *CkJwe_encrypt(HCkJwe cHandle, const char *content, const char *charset);
Encrypts string content to produce a JWE. The byte representation of the content is indicated by charset (such as "utf-8").
Supported Algorithms:
- RSAES OAEP 256 (using SHA-256 and MGF1 with SHA-256) encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- RSAES OAEP (using SHA-1 and MGF1 with SHA-1) encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- RSAES-PKCS1-V1_5 encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- Direct symmetric key encryption with pre-shared key A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM and A256GCM
- A128KW, A192KW, A256KW encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- A128GCMKW, A192GCMKW, A256GCMKW encryption with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
- PBES2-HS256+A128KW, PBES2-HS384+A192KW, PBES2-HS512+A256KW with A128CBC-HS256, A192CBC-HS384, A256CBC-HS512, A128GCM, A192GCM, A256GCM
Returns TRUE for success, FALSE for failure.
EncryptBd
Encrypts the contents of contentBd to produce a JWE that is appended to the contents of jweSb. (This method provides the means to produce a JWE from binary content.)
Returns TRUE for success, FALSE for failure.
EncryptSb
Encrypts the contents of contentSb to produce a JWE that is appended to the contents of jweSb. The byte representation of the string to be encrypted is indicated by charset (such as "utf-8").
Returns TRUE for success, FALSE for failure.
FindRecipient
Finds the index of the recipient with a header parameter (paramName) equal to a specified value (paramValue). Returns -1 if no recipient contains a header with the given name/value. If caseSensitive is TRUE, then the header param name/value comparisons are case sensitive. Otherwise it is case insensitive.
The procedure for decrypting a JWE with multiple recipients is the following:
- Load the JWE via one of the Load* methods.
- Find the recipient index by some identifying header paramter. The typical case is via the "kid" header parameter. ("kid" is an arbitrary key ID applications can assign to identify keys.)
- Set the key for decryption at the found index by calling SetPrivateKey, SetWrappingKey, or SetPassword, depending on the type of key wrapping that is employed.
- Call Decrypt, DecryptSb, or DecryptBd to decrypt for the recipient (and key) at the given index.
GetHeader
Returns the JSON header from the JWE. The JSON header is loaded into json.
Returns TRUE for success, FALSE for failure.
topGetProtectedHeader
Returns the shared protected JSON header from the JWE. The shared protected header is loaded into json.
Returns TRUE for success, FALSE for failure.
topLoadJwe
Loads the contents of a JWE.
Returns TRUE for success, FALSE for failure.
LoadJweSb
Loads the contents of a JWE from a StringBuilder object.
Returns TRUE for success, FALSE for failure.
SetAad
Sets the optional Additional Authenticated Data. This is only used for non-compact serializations. The charset specifies the character encoding (such as "utf-8") to be used for the byte representation for the additional authenticated data.
Returns TRUE for success, FALSE for failure.
topSetAadBd
Sets the optional Additional Authenticated Data. This is only used for non-compact serializations. This method provides a way for binary (non-text) additional authenticated data to be used.
Returns TRUE for success, FALSE for failure.
topSetPassword
Sets the PBES2 password for key encryption or decryption. This is for the case where the content encryption key (CEK) is encrypted using PBES2. An PBES2 password should be used in the cases where the "alg" header parameter value is equal to one of the following:
PBES2-HS256+A128KW PBES2-HS384+A192KW PBES2-HS512+A256KWThe index is the index of the recipient, where the 1st recipient is at index 0. (The typical use case for JWEs is for a single recipient.)
Returns TRUE for success, FALSE for failure.
topSetPrivateKey
Sets a private key for RSA key unwrapping/decryption. This is for the case where the content encryption key (CEK) is encrypted using RSA. An RSA private key should be used for decrypting in the cases where the "alg" header parameter value is equal to one of the following:
RSA1_5 RSA-OAEP RSA-OAEP-256 RSA-OAEP-384 (added in Chilkat v9.5.0.71) RSA-OAEP-512 (added in Chilkat v9.5.0.71)The index is the index of the recipient, where the 1st recipient is at index 0. (The typical use case for JWEs is for a single recipient.)
Returns TRUE for success, FALSE for failure.
SetProtectedHeader
Sets the JWE Protected Header.
Returns TRUE for success, FALSE for failure.
SetPublicKey
Sets a public key for RSA key wrapping encryption. This is for the case where the content encryption key (CEK) is encrypted using RSA. An RSA public key should be used when encrypting for the cases where the "alg" header parameter value is equal to one of the following:
RSA1_5 RSA-OAEP RSA-OAEP-256The index is the index of the recipient, where the 1st recipient is at index 0. (The typical use case for JWEs is for a single recipient.)
Returns TRUE for success, FALSE for failure.
SetRecipientHeader
Sets a per-recipient unprotected header. This method would only be called if the JWE is for multiple recipients. The 1st recipient is at index 0.
Returns TRUE for success, FALSE for failure.
topSetUnprotectedHeader
SetWrappingKey
Sets the AES wrapping key for encryption or decryption. This is for the case where the content encryption key (CEK) is encrypted using AES Key Wrap or AES GCM. An AES key should be used in the cases where the "alg" header parameter value is equal to one of the following:
A128KW A192KW A256KW A128GCMKW A192GCMKW A256GCMKW dirThe index is the index of the recipient, where the 1st recipient is at index 0. (The typical use case for JWEs is for a single recipient.)
Note: This method also sets the shared direct symmetric key for the case when the "alg" is equal to "dir". In this case, the key specified is not actualy a key encryption key, but is the direct content encryption key.
The encoding indicates the representation, such as "base64", "hex", "base64url", etc. of the encodedKey.
Returns TRUE for success, FALSE for failure.