encode.h File Reference

Core ENCODE function for l8w8jwt. Use this to encode a JWT header + payload WITHOUT signing. More...

#include "algs.h"
#include "claim.h"
#include "version.h"
#include "retcodes.h"
#include "timehelper.h"
#include <stddef.h>

Include dependency graph for encode.h:

Go to the source code of this file.

Classes
struct	l8w8jwt_encoding_params

Macros
#define	L8W8JWT_MAX_KEY_SIZE   8192

Functions
L8W8JWT_API void	l8w8jwt_encoding_params_init (struct l8w8jwt_encoding_params *params)
L8W8JWT_API int	l8w8jwt_validate_encoding_params (struct l8w8jwt_encoding_params *params)
L8W8JWT_API int	l8w8jwt_encode (struct l8w8jwt_encoding_params *params)

Detailed Description

Core ENCODE function for l8w8jwt. Use this to encode a JWT header + payload WITHOUT signing.

Author

Raphael Beck

Function Documentation

l8w8jwt_encode()

L8W8JWT_API int l8w8jwt_encode

(

struct l8w8jwt_encoding_params *

params

)

Creates, signs and encodes a Json-Web-Token.

An example output could be: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InNvbWUta2V5LWlkLWhlcmUtMDEyMzQ1NiJ9.eyJpYXQiOjE1Nzk2NDUzNTUsImV4cCI6MTU3OTY0NTk1NSwic3ViIjoiR29yZG9uIEZyZWVtYW4iLCJpc3MiOiJCbGFjayBNZXNhIiwiYXVkIjoiQWRtaW5pc3RyYXRvciJ9.uk4EEoq0ql_SguLto5EWzklakpzO-6GE2U26crB8vUY

Parameters

params

The token encoding parameters (e.g. "alg", "iss", "exp", etc...).

Returns

Return code as defined in retcodes.h

See also

l8w8jwt_encoding_params

l8w8jwt_encoding_params_init()

L8W8JWT_API void l8w8jwt_encoding_params_init

(

struct l8w8jwt_encoding_params *

params

)

Initializes a l8w8jwt_encoding_params instance by setting its fields to default values.

Parameters

params

The l8w8jwt_encoding_params to initialize (set to default values).

l8w8jwt_validate_encoding_params()

L8W8JWT_API int l8w8jwt_validate_encoding_params

(

struct l8w8jwt_encoding_params *

params

)

Validates a set of l8w8jwt_encoding_params.

Parameters

params

The l8w8jwt_encoding_params to validate.

Returns

Return code as defined in retcodes.h