jwt::jwks< json_traits > Class Template Reference

JWK Set. More...

#include <goby/util/thirdparty/jwt-cpp/jwt.h>

Public Types
using	jwks_t = jwk< json_traits >
	JWK instance template specialization.
using	jwks_vector_t = std::vector< jwks_t >
	Type specialization for the vector of JWK.
using	iterator = typename jwks_vector_t::iterator
using	const_iterator = typename jwks_vector_t::const_iterator

Public Member Functions
	jwks ()=default
JWT_CLAIM_EXPLICIT	jwks (const typename json_traits::string_type &str)
iterator	begin ()
iterator	end ()
const_iterator	cbegin () const
const_iterator	cend () const
const_iterator	begin () const
const_iterator	end () const
bool	has_jwk (const typename json_traits::string_type &key_id) const noexcept
jwks_t	get_jwk (const typename json_traits::string_type &key_id) const

Detailed Description

template<typename json_traits>
class jwt::jwks< json_traits >

JWK Set.

https://tools.ietf.org/html/rfc7517

A JSON object that represents a set of JWKs. The JSON object MUST have a "keys" member, which is an array of JWKs.

This container takes a JWKs and simplifies it to a vector of JWKs

Definition at line 4072 of file jwt.h.

Member Typedef Documentation

const_iterator

template<typename json_traits >

using jwt::jwks< json_traits >::const_iterator = typename jwks_vector_t::const_iterator

Definition at line 4079 of file jwt.h.

iterator

template<typename json_traits >

using jwt::jwks< json_traits >::iterator = typename jwks_vector_t::iterator

Definition at line 4078 of file jwt.h.

jwks_t

template<typename json_traits >

using jwt::jwks< json_traits >::jwks_t = jwk<json_traits>

JWK instance template specialization.

Definition at line 4075 of file jwt.h.

jwks_vector_t

template<typename json_traits >

using jwt::jwks< json_traits >::jwks_vector_t = std::vector<jwks_t>

Type specialization for the vector of JWK.

Definition at line 4077 of file jwt.h.

Constructor & Destructor Documentation

jwks() [1/2]

template<typename json_traits >

jwt::jwks< json_traits >::jwks ( )

default

Default constructor producing an empty object without any keys

jwks() [2/2]

template<typename json_traits >

JWT_CLAIM_EXPLICIT jwt::jwks< json_traits >::jwks ( const typename json_traits::string_type &  str )

inline

Parses a string buffer to extract the JWKS.

Parameters

str	buffer containing JSON object representing a JWKS

Exceptions

error::invalid_json_exception

or underlying JSON implation error if the JSON is invalid with regards to the JWKS specification

Definition at line 4092 of file jwt.h.

Member Function Documentation

begin() [1/2]

template<typename json_traits >

iterator jwt::jwks< json_traits >::begin ( )

inline

Definition at line 4104 of file jwt.h.

begin() [2/2]

template<typename json_traits >

const_iterator jwt::jwks< json_traits >::begin ( ) const

inline

Definition at line 4108 of file jwt.h.

cbegin()

template<typename json_traits >

const_iterator jwt::jwks< json_traits >::cbegin ( ) const

inline

Definition at line 4106 of file jwt.h.

cend()

template<typename json_traits >

const_iterator jwt::jwks< json_traits >::cend ( ) const

inline

Definition at line 4107 of file jwt.h.

end() [1/2]

template<typename json_traits >

iterator jwt::jwks< json_traits >::end ( )

inline

Definition at line 4105 of file jwt.h.

end() [2/2]

template<typename json_traits >

const_iterator jwt::jwks< json_traits >::end ( ) const

inline

Definition at line 4109 of file jwt.h.

get_jwk()

template<typename json_traits >

jwks_t jwt::jwks< json_traits >::get_jwk ( const typename json_traits::string_type &  key_id ) const

inline

Get jwk

Returns

Requested jwk by key_id

Exceptions

std::runtime_error

If jwk was not present

Definition at line 4124 of file jwt.h.

has_jwk()

template<typename json_traits >

bool jwt::jwks< json_traits >::has_jwk ( const typename json_traits::string_type &  key_id ) const

inlinenoexcept

Check if a jwk with the kid is present

Returns

true if jwk was present, false otherwise

Definition at line 4115 of file jwt.h.

---

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

• goby/util/thirdparty/jwt-cpp/jwt.h