CJOSE  0.4.1
Typedefs | Functions
jwe.h File Reference

Functions and data structures for interacting with JSON Web Encryption (JWE) objects. More...

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include "header.h"
#include "error.h"
#include "jwk.h"

Go to the source code of this file.

Typedefs

typedef struct _cjose_jwe_int cjose_jwe_t
 

Functions

cjose_jwe_tcjose_jwe_encrypt (const cjose_jwk_t *jwk, cjose_header_t *protected_header, const uint8_t *plaintext, size_t plaintext_len, cjose_err *err)
 
char * cjose_jwe_export (cjose_jwe_t *jwe, cjose_err *err)
 
cjose_jwe_tcjose_jwe_import (const char *compact, size_t compact_len, cjose_err *err)
 
uint8_t * cjose_jwe_decrypt (cjose_jwe_t *jwe, const cjose_jwk_t *jwk, size_t *content_len, cjose_err *err)
 
cjose_header_tcjose_jwe_get_protected (cjose_jwe_t *jwe)
 
void cjose_jwe_release (cjose_jwe_t *jwe)
 

Detailed Description

Functions and data structures for interacting with JSON Web Encryption (JWE) objects.

Typedef Documentation

§ cjose_jwe_t

typedef struct _cjose_jwe_int cjose_jwe_t

An instance of a JWE object.

Function Documentation

§ cjose_jwe_decrypt()

uint8_t* cjose_jwe_decrypt ( cjose_jwe_t jwe,
const cjose_jwk_t jwk,
size_t *  content_len,
cjose_err err 
)

Decrypts the JWE object using the given JWK. Returns the plaintext data of the JWE payload.

Parameters
jwe[in] the JWE object to decrypt.
jwk[in] the key to use for decrypting.
content_len[out] The number of byes in the returned buffer.
err[out] An optional error object which can be used to get additional information in the event of an error.
Returns
The decrypted content. Note the caller is responseible for free'ing this buffer when no longer in use. Failure to do so will result in a memory leak.

§ cjose_jwe_encrypt()

cjose_jwe_t* cjose_jwe_encrypt ( const cjose_jwk_t jwk,
cjose_header_t protected_header,
const uint8_t *  plaintext,
size_t  plaintext_len,
cjose_err err 
)

Creates a new JWE by encrypting the given plaintext within the given header and JWK.

If the header provided indicates an algorithm requiring an asymmetric key (e.g. RSA-OAEP), the provided JWK must be asymmetric (e.g. RSA or EC).

If the header provided indicates an algorithm requiring a symmetric key (e.g. (dir), the provided JWK must be symmetric (e.g. oct).

Parameters
jwk[in] the key to use for encrypting the JWE.
protected_header[in] additional header values to include in the JWE header.
plaintext[in] the plaintext to be encrypted in the JWE payload.
plaintext_len[in] the length of the plaintext.
err[out] An optional error object which can be used to get additional information in the event of an error.
Returns
a newly generated JWE with the given plaintext as the payload.

§ cjose_jwe_export()

char* cjose_jwe_export ( cjose_jwe_t jwe,
cjose_err err 
)

Creates a serialization of the given JWE object.

Note the current implementation only supports serialization to the JWE compact format.

Parameters
jwe[in] The JWE object to be serialized.
err[out] An optional error object which can be used to get additional information in the event of an error.
Returns
A pointer to a compact serialization of this JWE. Note the returned string pointer is owned by the caller, the caller must free it directly when no longer needed, or the memory will be leaked.

§ cjose_jwe_get_protected()

cjose_header_t* cjose_jwe_get_protected ( cjose_jwe_t jwe)

Returns the protected header of the JWE object.

NOTE: The returned header is still owned by the JWE object. Users must call cjose_header_retain() if it is expected to be valid after the owning cjose_jwe_t is released.

Parameters
jwe[in] the JWE object for which the protected header is requested.
Returns
the (parsed) protected header

§ cjose_jwe_import()

cjose_jwe_t* cjose_jwe_import ( const char *  compact,
size_t  compact_len,
cjose_err err 
)

Creates a new JWE object from the given JWE compact serialization.

Note the current implementation only recognizes the JWE compact serialization format.

Parameters
compact[in] a JWE in serialized form.
compact_len[in] the length of the compact serialization.
err[out] An optional error object which can be used to get additional information in the event of an error.
Returns
a newly generated JWE object from the given JWE serialization.

§ cjose_jwe_release()

void cjose_jwe_release ( cjose_jwe_t jwe)

Releases the given JWE object.

Parameters
jwethe JWE to be released. If null, this is a no-op.