jwt::builder< Clock, json_traits > Class Template Reference

#include <jwt.h>

Public Member Functions
JWT_CLAIM_EXPLICIT	builder (Clock c)
builder &	set_header_claim (const typename json_traits::string_type &id, typename json_traits::value_type c)
builder &	set_header_claim (const typename json_traits::string_type &id, basic_claim< json_traits > c)
builder &	set_payload_claim (const typename json_traits::string_type &id, typename json_traits::value_type c)
builder &	set_payload_claim (const typename json_traits::string_type &id, basic_claim< json_traits > c)
builder &	set_algorithm (typename json_traits::string_type str)
	Set algorithm claim You normally don't need to do this, as the algorithm is automatically set if you don't change it.
builder &	set_type (typename json_traits::string_type str)
builder &	set_content_type (typename json_traits::string_type str)
builder &	set_key_id (typename json_traits::string_type str)
	Set key id claim.
builder &	set_issuer (typename json_traits::string_type str)
builder &	set_subject (typename json_traits::string_type str)
builder &	set_audience (typename json_traits::array_type a)
builder &	set_audience (typename json_traits::string_type aud)
builder &	set_expires_at (const date &d)
template<class Rep >
builder &	set_expires_in (const std::chrono::duration< Rep > &d)
builder &	set_not_before (const date &d)
builder &	set_issued_at (const date &d)
builder &	set_issued_now ()
builder &	set_id (const typename json_traits::string_type &str)
template<typename Algo , typename Encode >
json_traits::string_type	sign (const Algo &algo, Encode encode) const
template<typename Algo >
json_traits::string_type	sign (const Algo &algo) const
template<typename Algo , typename Encode >
json_traits::string_type	sign (const Algo &algo, Encode encode, std::error_code &ec) const
template<typename Algo >
json_traits::string_type	sign (const Algo &algo, std::error_code &ec) const

Detailed Description

template<typename Clock, typename json_traits>
class jwt::builder< Clock, json_traits >

Builder class to build and sign a new token Use jwt::create() to get an instance of this class.

Constructor & Destructor Documentation

builder()

template<typename Clock , typename json_traits >

JWT_CLAIM_EXPLICIT jwt::builder< Clock, json_traits >::builder ( Clock c )

inline

Constructor for building a new builder instance

Parameters

c	Clock instance

Member Function Documentation

set_algorithm()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_algorithm ( typename json_traits::string_type str )

inline

Set algorithm claim You normally don't need to do this, as the algorithm is automatically set if you don't change it.

Parameters

str	Name of algorithm

Returns

*this to allow for method chaining

set_audience() [1/2]

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_audience ( typename json_traits::array_type a )

inline

Set audience claim

Parameters

a	Audience set

Returns

*this to allow for method chaining

set_audience() [2/2]

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_audience ( typename json_traits::string_type aud )

inline

Set audience claim

Parameters

aud	Single audience

Returns

*this to allow for method chaining

set_content_type()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_content_type ( typename json_traits::string_type str )

inline

Set content type claim

Parameters

str	Type to set

Returns

*this to allow for method chaining

set_expires_at()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_expires_at ( const date & d )

inline

Set expires at claim

Parameters

d	Expires time

Returns

*this to allow for method chaining

set_expires_in()

template<typename Clock , typename json_traits >

template<class Rep >

builder & jwt::builder< Clock, json_traits >::set_expires_in ( const std::chrono::duration< Rep > & d )

inline

Set expires at claim to d from the current moment

Parameters

d	token expiration timeout

Returns

*this to allow for method chaining

set_header_claim() [1/2]

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_header_claim ( const typename json_traits::string_type & id, basic_claim< json_traits > c )

inline

Set a header claim.

Parameters

id	Name of the claim
c	Claim to add

Returns

*this to allow for method chaining

set_header_claim() [2/2]

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_header_claim ( const typename json_traits::string_type & id, typename json_traits::value_type c )

inline

Set a header claim.

Parameters

id	Name of the claim
c	Claim to add

Returns

*this to allow for method chaining

set_id()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_id ( const typename json_traits::string_type & str )

inline

Set id claim

Parameters

str

ID to set

Returns

*this to allow for method chaining

set_issued_at()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_issued_at ( const date & d )

inline

Set issued at claim

Parameters

d	Issued at time, should be current time

Returns

*this to allow for method chaining

set_issued_now()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_issued_now ( )

inline

Set issued at claim to the current moment

Returns

*this to allow for method chaining

set_issuer()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_issuer ( typename json_traits::string_type str )

inline

Set issuer claim

Parameters

str	Issuer to set

Returns

*this to allow for method chaining

set_key_id()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_key_id ( typename json_traits::string_type str )

inline

Set key id claim.

Parameters

str	Key id to set

Returns

*this to allow for method chaining

set_not_before()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_not_before ( const date & d )

inline

Set not before claim

Parameters

d	First valid time

Returns

*this to allow for method chaining

set_payload_claim() [1/2]

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_payload_claim ( const typename json_traits::string_type & id, basic_claim< json_traits > c )

inline

Set a payload claim.

Parameters

id	Name of the claim
c	Claim to add

Returns

*this to allow for method chaining

set_payload_claim() [2/2]

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_payload_claim ( const typename json_traits::string_type & id, typename json_traits::value_type c )

inline

Set a payload claim.

Parameters

id	Name of the claim
c	Claim to add

Returns

*this to allow for method chaining

set_subject()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_subject ( typename json_traits::string_type str )

inline

Set subject claim

Parameters

str	Subject to set

Returns

*this to allow for method chaining

set_type()

template<typename Clock , typename json_traits >

builder & jwt::builder< Clock, json_traits >::set_type ( typename json_traits::string_type str )

inline

Set type claim

Parameters

str	Type to set

Returns

*this to allow for method chaining

sign() [1/4]

template<typename Clock , typename json_traits >

template<typename Algo >

json_traits::string_type jwt::builder< Clock, json_traits >::sign ( const Algo & algo ) const

inline

Sign token and return result

using the jwt::base functions provided

Parameters

algo	Instance of an algorithm to sign the token with

Returns

Final token as a string

sign() [2/4]

template<typename Clock , typename json_traits >

template<typename Algo , typename Encode >

json_traits::string_type jwt::builder< Clock, json_traits >::sign ( const Algo & algo, Encode encode ) const

inline

Sign token and return result

Template Parameters

Algo	Callable method which takes a string_type and return the signed input as a string_type
Encode	Callable method which takes a string_type and base64url safe encodes it, MUST return the result with no padding; trim the result.

Parameters

algo	Instance of an algorithm to sign the token with
encode	Callable to transform the serialized json to base64 with no padding

Returns

Final token as a string

Note

If the 'alg' header in not set in the token it will be set to algo.name()

sign() [3/4]

template<typename Clock , typename json_traits >

template<typename Algo , typename Encode >

json_traits::string_type jwt::builder< Clock, json_traits >::sign ( const Algo & algo, Encode encode, std::error_code & ec ) const

inline

Sign token and return result

Template Parameters

Algo	Callable method which takes a string_type and return the signed input as a string_type
Encode	Callable method which takes a string_type and base64url safe encodes it, MUST return the result with no padding; trim the result.

Parameters

algo	Instance of an algorithm to sign the token with
encode	Callable to transform the serialized json to base64 with no padding
ec	error_code filled with details on error

Returns

Final token as a string

Note

If the 'alg' header in not set in the token it will be set to algo.name()

sign() [4/4]

template<typename Clock , typename json_traits >

template<typename Algo >

json_traits::string_type jwt::builder< Clock, json_traits >::sign ( const Algo & algo, std::error_code & ec ) const

inline

Sign token and return result

using the jwt::base functions provided

Parameters

algo	Instance of an algorithm to sign the token with
ec	error_code filled with details on error

Returns

Final token as a string

---

The documentation for this class was generated from the following file:

• include/jwt-cpp/jwt.h