ccf::UserCertAuthnPolicy Class Reference

#include <cert_auth.h>

Inherits ccf::AuthnPolicy.

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

Static Public Attributes
static constexpr auto	SECURITY_SCHEME_NAME = "user_cert"

Protected Attributes
std::unique_ptr< ValidityPeriodsCache >	validity_periods

Constructor & Destructor Documentation

UserCertAuthnPolicy()

ccf::UserCertAuthnPolicy::UserCertAuthnPolicy

(

)

~UserCertAuthnPolicy()

ccf::UserCertAuthnPolicy::~UserCertAuthnPolicy ( )

virtualdefault

Member Function Documentation

authenticate()

std::unique_ptr< AuthnIdentity > ccf::UserCertAuthnPolicy::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::UserCertAuthnPolicy::get_openapi_security_schema ( ) const

inlineoverridevirtual

Implements ccf::AuthnPolicy.

get_security_scheme_name()

virtual std::string ccf::UserCertAuthnPolicy::get_security_scheme_name ( )

inlineoverridevirtual

Implements ccf::AuthnPolicy.

Member Data Documentation

SECURITY_SCHEME_NAME

constexpr auto ccf::UserCertAuthnPolicy::SECURITY_SCHEME_NAME = "user_cert"

staticconstexpr

validity_periods

std::unique_ptr<ValidityPeriodsCache> ccf::UserCertAuthnPolicy::validity_periods

protected

---

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

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