ccf::TypedUserCOSESign1AuthnPolicy Class Reference

#include <cose_auth.h>

Inherits ccf::UserCOSESign1AuthnPolicy.

Public Member Functions
	TypedUserCOSESign1AuthnPolicy (const std::string &expected_msg_type_, const std::string &msg_type_name_="ccf.msg.type", const std::string &msg_created_at_name_="ccf.msg.created_at")
std::unique_ptr< AuthnIdentity >	authenticate (ccf::kv::ReadOnlyTx &tx, const std::shared_ptr< ccf::RpcContext > &ctx, std::string &error_reason) override
std::string	get_security_scheme_name () override
Public Member Functions inherited from ccf::UserCOSESign1AuthnPolicy
	UserCOSESign1AuthnPolicy (const std::string &msg_type_name_="ccf.msg.type", const std::string &msg_created_at_name_="ccf.msg.created_at")
	~UserCOSESign1AuthnPolicy ()
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 = "typed_user_cose_sign1"
Static Public Attributes inherited from ccf::UserCOSESign1AuthnPolicy
static constexpr auto	SECURITY_SCHEME_NAME = "user_cose_sign1"

Additional Inherited Members
Protected Member Functions inherited from ccf::UserCOSESign1AuthnPolicy
virtual std::unique_ptr< UserCOSESign1AuthnIdentity >	_authenticate (ccf::kv::ReadOnlyTx &tx, const std::shared_ptr< ccf::RpcContext > &ctx, std::string &error_reason)
Static Protected Attributes inherited from ccf::UserCOSESign1AuthnPolicy
static const OpenAPISecuritySchema	security_schema

Detailed Description

Typed User COSE Sign1 Authentication Policy

Extends UserCOSESign1AuthPolicy, to require that a specific message type is present in the corresponding protected header.

Constructor & Destructor Documentation

TypedUserCOSESign1AuthnPolicy()

ccf::TypedUserCOSESign1AuthnPolicy::TypedUserCOSESign1AuthnPolicy ( const std::string &  expected_msg_type_, const std::string &  msg_type_name_ = "ccf.msg.type", const std::string &  msg_created_at_name_ = "ccf.msg.created_at"  )

inline

Member Function Documentation

authenticate()

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

overridevirtual

Implements ccf::AuthnPolicy.

get_security_scheme_name()

std::string ccf::TypedUserCOSESign1AuthnPolicy::get_security_scheme_name ( )

inlineoverridevirtual

Implements ccf::AuthnPolicy.

Member Data Documentation

SECURITY_SCHEME_NAME

constexpr auto ccf::TypedUserCOSESign1AuthnPolicy::SECURITY_SCHEME_NAME = "typed_user_cose_sign1"

staticconstexpr

---

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

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