ccf::AuthnPolicy Class Reference

#include <authentication_types.h>

Inherited by ccf::AllOfAuthnPolicy, ccf::AnyCertAuthnPolicy, ccf::EmptyAuthnPolicy, ccf::JwtAuthnPolicy, ccf::MemberCOSESign1AuthnPolicy, ccf::MemberCertAuthnPolicy, ccf::NodeCertAuthnPolicy, ccf::UserCOSESign1AuthnPolicy, ccf::UserCertAuthnPolicy, and loggingapp::CustomAuthPolicy.

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

Constructor & Destructor Documentation

~AuthnPolicy()

virtual ccf::AuthnPolicy::~AuthnPolicy ( )

virtualdefault

Member Function Documentation

authenticate()

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

pure virtual

Implemented in ccf::AllOfAuthnPolicy, ccf::EmptyAuthnPolicy, loggingapp::CustomAuthPolicy, ccf::UserCertAuthnPolicy, ccf::MemberCertAuthnPolicy, ccf::NodeCertAuthnPolicy, ccf::AnyCertAuthnPolicy, ccf::MemberCOSESign1AuthnPolicy, ccf::ActiveMemberCOSESign1AuthnPolicy, ccf::UserCOSESign1AuthnPolicy, ccf::TypedUserCOSESign1AuthnPolicy, and ccf::JwtAuthnPolicy.

get_openapi_security_schema()

virtual std::optional< OpenAPISecuritySchema > ccf::AuthnPolicy::get_openapi_security_schema ( ) const

pure virtual

Implemented in ccf::AllOfAuthnPolicy, ccf::UserCertAuthnPolicy, ccf::MemberCertAuthnPolicy, ccf::NodeCertAuthnPolicy, ccf::AnyCertAuthnPolicy, ccf::MemberCOSESign1AuthnPolicy, ccf::UserCOSESign1AuthnPolicy, ccf::EmptyAuthnPolicy, ccf::JwtAuthnPolicy, and loggingapp::CustomAuthPolicy.

get_security_scheme_name()

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

pure virtual

Implemented in ccf::AllOfAuthnPolicy, ccf::UserCertAuthnPolicy, ccf::MemberCertAuthnPolicy, ccf::NodeCertAuthnPolicy, ccf::AnyCertAuthnPolicy, ccf::MemberCOSESign1AuthnPolicy, ccf::ActiveMemberCOSESign1AuthnPolicy, ccf::UserCOSESign1AuthnPolicy, ccf::TypedUserCOSESign1AuthnPolicy, ccf::EmptyAuthnPolicy, ccf::JwtAuthnPolicy, and loggingapp::CustomAuthPolicy.

set_unauthenticated_error()

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

inlinevirtual

Reimplemented in ccf::MemberCOSESign1AuthnPolicy, ccf::UserCOSESign1AuthnPolicy, ccf::JwtAuthnPolicy, ccf::AllOfAuthnPolicy, and ccf::EmptyAuthnPolicy.

---

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

• include/ccf/endpoints/authentication/authentication_types.h