JSON Web Token (JWT)

JSON Web Token (JWT) - RFC 7519 . More...

Data Structures
struct	jwt_builder
	JWT data tracking. More...

Functions
int	jwt_init_builder (struct jwt_builder *builder, char *buffer, size_t buffer_size)
	Initialize the JWT builder.
int	jwt_add_payload (struct jwt_builder *builder, int32_t exp, int32_t iat, const char *aud)
	Add JWT payload.
int	jwt_sign (struct jwt_builder *builder, const char *der_key, size_t der_key_len)
	Sign the JWT.

Detailed Description

JSON Web Token (JWT) - RFC 7519 .

Function Documentation

jwt_add_payload()

int jwt_add_payload	(	struct jwt_builder *	builder,
		int32_t	exp,
		int32_t	iat,
		const char *	aud )

#include <zephyr/data/jwt.h>

Add JWT payload.

Add JWT payload to a previously initialized builder with the following fields:

• Expiration Time
• Issued At
• Audience

See RFC 7519 section 4.1 to get more information about these fields.

Parameters

builder	A previously initialized builder.
exp	Expiration Time (epoch format).
iat	Issued At (epoch format).
aud	Audience.

Return values

0	Success.
<0	Failure.

jwt_init_builder()

int jwt_init_builder	(	struct jwt_builder *	builder,
		char *	buffer,
		size_t	buffer_size )

#include <zephyr/data/jwt.h>

Initialize the JWT builder.

Initialize the given JWT builder for the creation of a fresh token. The buffer size should be long enough to store the entire token.

Parameters

builder	The builder to initialize.
buffer	The buffer to write the token to.
buffer_size	The size of this buffer. The token will be NULL terminated, which needs to be allowed for in this size.

Return values

0	Success.
-ENOSPC	Buffer is insufficient to initialize.

jwt_sign()

int jwt_sign	(	struct jwt_builder *	builder,
		const char *	der_key,
		size_t	der_key_len )

#include <zephyr/data/jwt.h>

Sign the JWT.

Sign a previously initialized with payload JWT.

Parameters

builder	A previously initialized builder with payload.
der_key	Private key to use in DER format.
der_key_len	Size of the private key in bytes.

Return values

0	Success.
<0	Failure.