ccf::JwtAuthnPolicy Class Reference

#include <jwt_auth.h>

Inherits ccf::AuthnPolicy.

Public Member Functions
	JwtAuthnPolicy ()
virtual	~JwtAuthnPolicy ()
std::unique_ptr< AuthnIdentity >	authenticate (ccf::kv::ReadOnlyTx &tx, const std::shared_ptr< ccf::RpcContext > &ctx, std::string &error_reason) override
void	set_unauthenticated_error (std::shared_ptr< ccf::RpcContext > ctx, std::string &&error_reason) override
std::optional< OpenAPISecuritySchema >	get_openapi_security_schema () const override
std::string	get_security_scheme_name () override
Public Member Functions inherited from ccf::AuthnPolicy
virtual	~AuthnPolicy ()=default

Static Public Attributes
static constexpr auto	SECURITY_SCHEME_NAME = "jwt"

Protected Attributes
std::unique_ptr< PublicKeysCache >	keys_cache

Static Protected Attributes
static const OpenAPISecuritySchema	security_schema

Constructor & Destructor Documentation

JwtAuthnPolicy()

ccf::JwtAuthnPolicy::JwtAuthnPolicy

(

)

~JwtAuthnPolicy()

ccf::JwtAuthnPolicy::~JwtAuthnPolicy ( )

virtualdefault

Member Function Documentation

authenticate()

std::unique_ptr< AuthnIdentity > ccf::JwtAuthnPolicy::authenticate ( ccf::kv::ReadOnlyTx &  tx, const std::shared_ptr< ccf::RpcContext > &  ctx, std::string &  error_reason  )

overridevirtual

Implements ccf::AuthnPolicy.

get_openapi_security_schema()

std::optional< OpenAPISecuritySchema > ccf::JwtAuthnPolicy::get_openapi_security_schema ( ) const

inlineoverridevirtual

Implements ccf::AuthnPolicy.

get_security_scheme_name()

std::string ccf::JwtAuthnPolicy::get_security_scheme_name ( )

inlineoverridevirtual

Implements ccf::AuthnPolicy.

set_unauthenticated_error()

void ccf::JwtAuthnPolicy::set_unauthenticated_error ( std::shared_ptr< ccf::RpcContext >  ctx, std::string &&  error_reason  )

overridevirtual

Reimplemented from ccf::AuthnPolicy.

Member Data Documentation

keys_cache

std::unique_ptr<PublicKeysCache> ccf::JwtAuthnPolicy::keys_cache

protected

security_schema

const OpenAPISecuritySchema ccf::JwtAuthnPolicy::security_schema

staticprotected

Initial value:

= std::make_pair(
    JwtAuthnPolicy::SECURITY_SCHEME_NAME,
    nlohmann::json{
      {"type", "http"}, {"scheme", "bearer"}, {"bearerFormat", "JWT"}})

SECURITY_SCHEME_NAME

constexpr auto ccf::JwtAuthnPolicy::SECURITY_SCHEME_NAME = "jwt"

staticconstexpr

---

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

• include/ccf/endpoints/authentication/jwt_auth.h
• src/endpoints/authentication/jwt_auth.cpp