ccf::NetworkIdentitySubsystemInterface Class Reference

#include <network_identity_interface.h>

Inherits ccf::AbstractNodeSubSystem.

Inherited by ccf::NetworkIdentitySubsystem.

Public Member Functions
	~NetworkIdentitySubsystemInterface () override=default
virtual const std::unique_ptr< NetworkIdentity > &	get ()=0
	Returns a reference to the current network identity.
virtual FetchStatus	endorsements_fetching_status () const =0
	Returns the current status of endorsement fetching.
virtual std::optional< CoseEndorsementsChain >	get_cose_endorsements_chain (ccf::SeqNo seqno) const =0
virtual ccf::crypto::ECPublicKeyPtr	get_trusted_identity_for (ccf::SeqNo seqno) const =0
virtual TrustedKeys	get_trusted_keys () const =0
Public Member Functions inherited from ccf::AbstractNodeSubSystem
virtual	~AbstractNodeSubSystem ()=default

Static Public Member Functions
static char const *	get_subsystem_name ()

Detailed Description

Interface for accessing the network identity subsystem, which manages the service's cryptographic identity and its historical trusted keys.

Constructor & Destructor Documentation

~NetworkIdentitySubsystemInterface()

ccf::NetworkIdentitySubsystemInterface::~NetworkIdentitySubsystemInterface ( )

overridedefault

Member Function Documentation

endorsements_fetching_status()

virtual FetchStatus ccf::NetworkIdentitySubsystemInterface::endorsements_fetching_status ( ) const

pure virtual

Returns the current status of endorsement fetching.

Implemented in ccf::NetworkIdentitySubsystem.

get()

virtual const std::unique_ptr< NetworkIdentity > & ccf::NetworkIdentitySubsystemInterface::get ( )

pure virtual

Returns a reference to the current network identity.

Implemented in ccf::NetworkIdentitySubsystem.

get_cose_endorsements_chain()

virtual std::optional< CoseEndorsementsChain > ccf::NetworkIdentitySubsystemInterface::get_cose_endorsements_chain ( ccf::SeqNo  seqno ) const

pure virtual

Returns the COSE endorsements chain for the given sequence number, or std::nullopt if the chain is not available for the given sequence number.

Exceptions

IdentityHistoryNotFetched

if identity history fetching has not completed.

Implemented in ccf::NetworkIdentitySubsystem.

get_subsystem_name()

static char const * ccf::NetworkIdentitySubsystemInterface::get_subsystem_name ( )

inlinestatic

get_trusted_identity_for()

virtual ccf::crypto::ECPublicKeyPtr ccf::NetworkIdentitySubsystemInterface::get_trusted_identity_for ( ccf::SeqNo  seqno ) const

pure virtual

Returns the trusted EC public key that was active at the given sequence number, or nullptr if the sequence number precedes the earliest known trusted key.

Exceptions

IdentityHistoryNotFetched	if identity history fetching has not completed.
std::logic_error	if no trusted keys have been fetched, or if internal key resolution is inconsistent.

Implemented in ccf::NetworkIdentitySubsystem.

get_trusted_keys()

virtual TrustedKeys ccf::NetworkIdentitySubsystemInterface::get_trusted_keys ( ) const

pure virtual

Returns all trusted network identity keys as a map from sequence number to EC public key.

Exceptions

IdentityHistoryNotFetched

if identity history fetching has not completed.

Implemented in ccf::NetworkIdentitySubsystem.

---

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

• include/ccf/network_identity_interface.h