jwt Namespace Reference

JSON Web Token. More...

Namespaces
namespace	algorithm
	Various cryptographic algorithms when working with JWT.
namespace	alphabet
	character maps when encoding and decoding
namespace	base
	A collection of fellable functions for working with base64 and base64url.
namespace	details
namespace	error
	Everything related to error codes issued by the library.
namespace	helper
	A collection for working with certificates.
namespace	json
	JSON Abstractions for working with any library.
namespace	traits
	Namespace containing all the json_trait implementations for a jwt::basic_claim.
namespace	verify_ops

Classes
class	basic_claim
	a class to store a generic JSON value as claim More...
class	builder
class	decoded_jwt
struct	default_clock
class	header
class	jwk
	JSON Web Key. More...
class	jwks
	JWK Set. More...
class	payload
class	verifier

Typedefs
using	date = std::chrono::system_clock::time_point
using	claim = basic_claim< traits::nlohmann_json >
	a class to store a generic JSON for Modern C++ value as claim
using	verify_context = verify_ops::verify_context< traits::nlohmann_json >

Functions
template<typename Clock , typename json_traits >
verifier< Clock, json_traits >	verify (Clock c)
template<typename Clock , typename json_traits >
builder< Clock, json_traits >	create (Clock c)
template<typename json_traits >
verifier< default_clock, json_traits >	verify (default_clock c={})
template<typename json_traits >
builder< default_clock, json_traits >	create (default_clock c={})
template<typename json_traits , typename Decode >
decoded_jwt< json_traits >	decode (const typename json_traits::string_type &token, Decode decode)
	Decode a token. This can be used to to help access important feild like 'x5c' for verifying tokens. See associated example rsa-verify.cpp for more details.
template<typename json_traits >
decoded_jwt< json_traits >	decode (const typename json_traits::string_type &token)
template<typename json_traits >
jwk< json_traits >	parse_jwk (const typename json_traits::string_type &jwk_)
template<typename json_traits >
jwks< json_traits >	parse_jwks (const typename json_traits::string_type &jwks_)
verifier< default_clock, traits::nlohmann_json >	verify ()
builder< default_clock, traits::nlohmann_json >	create ()
decoded_jwt< traits::nlohmann_json >	decode (const std::string &token)
template<typename Decode >
decoded_jwt< traits::nlohmann_json >	decode (const std::string &token, Decode decode)
jwk< traits::nlohmann_json >	parse_jwk (const traits::nlohmann_json::string_type &token)
jwks< traits::nlohmann_json >	parse_jwks (const traits::nlohmann_json::string_type &token)

Detailed Description

JSON Web Token.

A namespace to contain everything related to handling JSON Web Tokens, JWT for short, as a part of RFC7519, or alternatively for JWS (JSON Web Signature) from RFC7515

Typedef Documentation

claim

using jwt::claim = typedef basic_claim<traits::nlohmann_json>

a class to store a generic JSON for Modern C++ value as claim

This type is the specialization of the basic_claim class which uses the standard template types.

Definition at line 17 of file defaults.h.

date

using jwt::date = typedef std::chrono::system_clock::time_point

Default system time point in UTC

Definition at line 86 of file jwt.h.

verify_context

using jwt::verify_context = typedef verify_ops::verify_context<traits::nlohmann_json>

This type is the specialization of the verify_ops::verify_context class which uses the standard template types.

Definition at line 88 of file defaults.h.

Function Documentation

create() [1/3]

builder< default_clock, traits::nlohmann_json > jwt::create ( )

inline

Create a builder using the default clock

Returns

builder instance to create a new token

Definition at line 31 of file defaults.h.

create() [2/3]

template<typename Clock , typename json_traits >

builder< Clock, json_traits > jwt::create

(

Clock

c

)

Create a builder using the given clock

Parameters

c	Clock instance to use

Returns

builder instance

Definition at line 4157 of file jwt.h.

create() [3/3]

template<typename json_traits >

builder< default_clock, json_traits > jwt::create

(

default_clock

c = {}

)

Return a builder instance to create a new token

Definition at line 4189 of file jwt.h.

decode() [1/4]

decoded_jwt< traits::nlohmann_json > jwt::decode ( const std::string &  token )

inline

Decode a token

Parameters

token

Token to decode

Returns

Decoded token

Exceptions

std::invalid_argument	Token is not in correct format
std::runtime_error	Base64 decoding failed or invalid json

Definition at line 43 of file defaults.h.

decode() [2/4]

template<typename Decode >

decoded_jwt< traits::nlohmann_json > jwt::decode	(	const std::string &	token,
		Decode	decode
	)

Decode a token

Template Parameters

Decode

is callable, taking a string_type and returns a string_type. It should ensure the padding of the input and then base64url decode and return the results.

Parameters

token	Token to decode
decode	The token to parse

Returns

Decoded token

Exceptions

std::invalid_argument	Token is not in correct format
std::runtime_error	Base64 decoding failed or invalid json

Definition at line 60 of file defaults.h.

decode() [3/4]

template<typename json_traits >

decoded_jwt< json_traits > jwt::decode

(

const typename json_traits::string_type &

token

)

Decode a token. This can be used to to help access important feild like 'x5c' for verifying tokens. See associated example rsa-verify.cpp for more details.

Template Parameters

json_traits

JSON implementation traits

Parameters

token

Token to decode

Returns

Decoded token

Exceptions

std::invalid_argument	Token is not in correct format
std::runtime_error	Base64 decoding failed or invalid json

Definition at line 4223 of file jwt.h.

decode() [4/4]

template<typename json_traits , typename Decode >

decoded_jwt< json_traits > jwt::decode	(	const typename json_traits::string_type &	token,
		Decode	decode
	)

Decode a token. This can be used to to help access important feild like 'x5c' for verifying tokens. See associated example rsa-verify.cpp for more details.

Template Parameters

json_traits	JSON implementation traits
Decode	is callable, taking a string_type and returns a string_type. It should ensure the padding of the input and then base64url decode and return the results.

Parameters

token	Token to decode
decode	function that will pad and base64url decode the token

Returns

Decoded token

Exceptions

std::invalid_argument	Token is not in correct format
std::runtime_error	Base64 decoding failed or invalid json

Definition at line 4208 of file jwt.h.

parse_jwk() [1/2]

jwk< traits::nlohmann_json > jwt::parse_jwk ( const traits::nlohmann_json::string_type &  token )

inline

Parse a jwk

Parameters

token

JWK Token to parse

Returns

Parsed JWK

Exceptions

std::runtime_error

Token is not in correct format

Definition at line 70 of file defaults.h.

parse_jwk() [2/2]

template<typename json_traits >

jwk< json_traits > jwt::parse_jwk

(

const typename json_traits::string_type &

jwk_

)

Parse a single JSON Web Key

Template Parameters

json_traits

JSON implementation traits

Parameters

jwk_	string buffer containing the JSON object

Returns

Decoded jwk

Definition at line 4233 of file jwt.h.

parse_jwks() [1/2]

jwks< traits::nlohmann_json > jwt::parse_jwks ( const traits::nlohmann_json::string_type &  token )

inline

Parse a jwks

Parameters

token

JWKs Token to parse

Returns

Parsed JWKs

Exceptions

std::runtime_error

Token is not in correct format

Definition at line 80 of file defaults.h.

parse_jwks() [2/2]

template<typename json_traits >

jwks< json_traits > jwt::parse_jwks

(

const typename json_traits::string_type &

jwks_

)

Parse a JSON Web Key Set. This can be used to to help access important feild like 'x5c' for verifying tokens. See example jwks-verify.cpp for more information.

Template Parameters

json_traits

JSON implementation traits

Parameters

jwks_

string buffer containing the JSON object

Returns

Parsed JSON object containing the data of the JWK SET string

Exceptions

std::runtime_error

Token is not in correct format

Definition at line 4247 of file jwt.h.

verify() [1/3]

verifier< default_clock, traits::nlohmann_json > jwt::verify ( )

inline

Create a verifier using the default clock

Returns

verifier instance

Definition at line 23 of file defaults.h.

verify() [2/3]

template<typename Clock , typename json_traits >

verifier< Clock, json_traits > jwt::verify

(

Clock

c

)

Create a verifier using the given clock

Parameters

c	Clock instance to use

Returns

verifier instance

Definition at line 4147 of file jwt.h.

verify() [3/3]

template<typename json_traits >

verifier< default_clock, json_traits > jwt::verify

(

default_clock

c = {}

)

Create a verifier using the default_clock.

Parameters

c	Clock instance to use

Returns

verifier instance

Definition at line 4181 of file jwt.h.