29#include <unordered_set>
34 struct PrimarySignature;
57 NodeInfo(std::string hostname_, std::string port_) :
68 using Nodes = std::map<NodeId, NodeInfo>;
77 j[
"address"] = fmt::format(
"{}:{}", ni.
hostname, ni.
port);
82 const std::string addr(j[
"address"]);
83 const auto& [h, p] = ccf::nonstd::split_1(addr,
":");
90 return "Configuration__NodeInfo";
96 schema[
"type"] =
"object";
97 schema[
"required"] = nlohmann::json::array();
98 schema[
"required"].push_back(
"address");
99 schema[
"properties"] = nlohmann::json::object();
100 schema[
"properties"][
"address"] = nlohmann::json::object();
101 schema[
"properties"][
"address"][
"$ref"] =
"#/components/schemas/string";
159 std::unordered_map<ccf::NodeId, Ack>
acks;
163 std::optional<std::unordered_map<ccf::NodeId, ccf::SeqNo>>
learners =
185 reconfiguration_type,
204 std::shared_ptr<std::vector<uint8_t>>,
206 std::shared_ptr<ConsensusHookPtrs>>>;
239 static bool has_claims(
const EntryType& et)
245 static bool has_commit_evidence(
const EntryType& et)
253 static_assert(
sizeof(
EntryType) ==
sizeof(
bool));
257 static inline SecurityDomain get_security_domain(
const std::string& name)
267 static inline std::pair<SecurityDomain, AccessCategory> parse_map_name(
268 std::string_view name)
270 constexpr auto internal_category_prefix =
"ccf.internal.";
271 constexpr auto governance_category_prefix =
"ccf.gov.";
272 constexpr auto reserved_category_prefix =
"ccf.";
282 if (name.starts_with(internal_category_prefix))
286 else if (name.starts_with(governance_category_prefix))
290 else if (name.starts_with(reserved_category_prefix))
292 throw std::logic_error(fmt::format(
293 "Map name '{}' includes disallowed reserved prefix '{}'",
295 reserved_category_prefix));
298 return {security_domain, access_category};
322 [[nodiscard]]
const char*
what() const noexcept
override
344 const std::vector<uint8_t>& hash_at_snapshot) = 0;
346 virtual void append(
const std::vector<uint8_t>& data) = 0;
349 std::optional<ccf::kv::Term> expected_term = std::nullopt) = 0;
358 std::shared_ptr<ccf::crypto::ECKeyPair_OpenSSL> keypair,
402 const NodeId& from,
const uint8_t* data,
size_t size) = 0;
404 virtual void periodic(std::chrono::milliseconds ) {}
410 ccf::SeqNo ,
const std::vector<NodeId>& node_ids)
422 std::vector<ConsensusHookPtr>
hooks;
426 std::vector<uint8_t>&& data_,
429 std::vector<ConsensusHookPtr>&& hooks_) :
448 std::vector<uint8_t> data;
455 std::vector<uint8_t>&& data_,
459 data(
std::move(data_)),
460 claims_digest(
std::move(claims_digest_)),
461 commit_evidence_digest(
std::move(commit_evidence_digest_)),
462 hooks(
std::move(hooks_))
470 std::move(claims_digest),
471 std::move(commit_evidence_digest),
482 const std::vector<uint8_t>& plain,
483 const std::vector<uint8_t>& additional_data,
484 std::vector<uint8_t>& serialised_header,
485 std::vector<uint8_t>& cipher,
488 bool historical_hint =
false) = 0;
490 const std::vector<uint8_t>& cipher,
491 const std::vector<uint8_t>& additional_data,
492 const std::vector<uint8_t>& serialised_header,
493 std::vector<uint8_t>& plain,
496 bool historical_hint =
false) = 0;
501 virtual uint64_t
get_term(
const uint8_t* data,
size_t size) = 0;
504 const ccf::TxID& tx_id,
bool historical_hint =
false) = 0;
539 class AbstractMap :
public std::enable_shared_from_this<AbstractMap>,
561 bool include_reads) = 0;
582 bool track_deletes_on_missing_keys =
false) = 0;
590 virtual std::optional<ccf::crypto::Sha256Hash>&&
618 const std::shared_ptr<AbstractTxEncryptor>& encryptor) = 0;
627 virtual std::tuple<Version, Version>
next_version(
bool commit_new_map) = 0;
638 Version v,
const std::string& map_name) = 0;
640 Version v,
const std::string& map_name) = 0;
642 Version v,
const std::shared_ptr<AbstractMap>&
map) = 0;
649 const std::vector<uint8_t>& data,
650 bool public_only =
false,
651 const std::optional<ccf::TxID>& expected_txid = std::nullopt) = 0;
657 std::unique_ptr<PendingTx> pending_tx,
658 bool globally_committable) = 0;
666 std::unique_ptr<AbstractSnapshot> snapshot) = 0;
671 std::vector<Version>* view_history =
nullptr,
672 bool public_only =
false) = 0;
691 template <
class StorePo
inter>
702 store->unlock_maps();
714struct formatter<
ccf::kv::Configuration::Nodes>
716 template <
typename ParseContext>
717 constexpr auto parse(ParseContext& ctx)
722 template <
typename FormatContext>
724 const ->
decltype(ctx.out())
726 std::set<ccf::NodeId> node_ids;
727 for (
const auto& [nid, _] : nodes)
729 node_ids.insert(nid);
731 return fmt::format_to(ctx.out(),
"{{{}}}", fmt::join(node_ids,
" "));
736struct formatter<
ccf::kv::MembershipState>
738 template <
typename ParseContext>
739 constexpr auto parse(ParseContext& ctx)
744 template <
typename FormatContext>
746 ->
decltype(ctx.out())
748 const auto s = nlohmann::json(state).get<std::string>();
749 return format_to(ctx.out(),
"{}", s);
754struct formatter<
ccf::kv::LeadershipState>
756 template <
typename ParseContext>
757 constexpr auto parse(ParseContext& ctx)
762 template <
typename FormatContext>
764 ->
decltype(ctx.out())
766 const auto s = nlohmann::json(state).get<std::string>();
767 return format_to(ctx.out(),
"{}", s);
Definition claims_digest.h:10
Definition sha256_hash.h:16
Definition kv_types.h:520
virtual bool has_writes() const =0
virtual ~AbstractChangeSet()=default
Definition kv_types.h:528
virtual void commit(Version v, bool track_deletes_on_missing_keys)=0
virtual ConsensusHookPtr post_commit()=0
virtual ~AbstractCommitter()=default
virtual bool has_writes()=0
Definition kv_types.h:578
virtual ccf::kv::ConsensusHookPtrs & get_hooks()=0
virtual ccf::kv::ApplyResult apply(bool track_deletes_on_missing_keys=false)=0
virtual ~AbstractExecutionWrapper()=default
virtual bool should_rollback_to_last_committed()=0
virtual bool is_public_only()=0
virtual std::optional< ccf::crypto::Sha256Hash > && consume_commit_evidence_digest()=0
virtual const std::vector< uint8_t > & get_entry()=0
virtual ccf::kv::Term get_term()=0
virtual bool support_async_execution()=0
virtual ccf::ClaimsDigest && consume_claims_digest()=0
virtual ccf::kv::Version get_index()=0
Definition kv_types.h:544
virtual void serialise(KvStoreSerialiser &s)=0
virtual SecurityDomain get_security_domain() const =0
virtual ~Snapshot()=default
Definition kv_types.h:541
virtual std::unique_ptr< Snapshot > snapshot(Version v)=0
virtual SecurityDomain get_security_domain()=0
virtual AbstractStore * get_store()=0
~AbstractMap() override=default
virtual std::unique_ptr< AbstractCommitter > create_committer(AbstractChangeSet *changes)=0
virtual AbstractMap * clone(AbstractStore *store)=0
virtual void post_compact()=0
virtual void serialise_changes(const AbstractChangeSet *changes, KvStoreSerialiser &s, bool include_reads)=0
virtual void compact(Version v)=0
virtual void rollback(Version v)=0
virtual void swap(AbstractMap *map)=0
Definition kv_types.h:509
virtual void rollback(ccf::kv::Version v)=0
virtual bool record_committable(ccf::kv::Version v)=0
virtual void commit(ccf::kv::Version v, bool generate_snapshot)=0
virtual ~AbstractSnapshotter()=default
Definition kv_types.h:613
virtual std::vector< uint8_t > serialise(const std::shared_ptr< AbstractTxEncryptor > &encryptor)=0
virtual ~AbstractSnapshot()=default
virtual Version get_version() const =0
Definition kv_types.h:610
virtual std::unique_ptr< AbstractSnapshot > snapshot_unsafe_maps(Version v)=0
virtual CommitResult commit(const ccf::TxID &txid, std::unique_ptr< PendingTx > pending_tx, bool globally_committable)=0
virtual bool flag_enabled_unsafe(StoreFlag f) const =0
virtual ccf::TxID next_txid()=0
StoreFlag
Definition kv_types.h:679
@ SNAPSHOT_AT_NEXT_SIGNATURE
virtual std::shared_ptr< TxHistory > get_history()=0
virtual std::shared_ptr< AbstractMap > get_map(Version v, const std::string &map_name)=0
virtual EncryptorPtr get_encryptor()=0
virtual void add_dynamic_map(Version v, const std::shared_ptr< AbstractMap > &map)=0
virtual bool should_create_ledger_chunk_unsafe(Version version)=0
virtual void set_flag_unsafe(StoreFlag f)=0
virtual void compact(Version v)=0
virtual std::pair< ccf::TxID, Term > current_txid_and_commit_term()=0
virtual bool should_create_ledger_chunk(Version version)=0
virtual std::shared_ptr< Consensus > get_consensus()=0
virtual void lock_map_set()=0
virtual std::shared_ptr< AbstractMap > get_map_unsafe(Version v, const std::string &map_name)=0
virtual bool flag_enabled(StoreFlag f)=0
virtual void unlock_map_set()=0
virtual std::unique_ptr< AbstractExecutionWrapper > deserialize(const std::vector< uint8_t > &data, bool public_only=false, const std::optional< ccf::TxID > &expected_txid=std::nullopt)=0
virtual size_t committable_gap()=0
virtual void unset_flag(StoreFlag f)=0
virtual void lock_maps()=0
virtual Version current_version()=0
virtual Term commit_view()=0
virtual Version next_version()=0
virtual void set_flag(StoreFlag f)=0
virtual bool check_rollback_count(Version count)=0
virtual std::shared_ptr< ILedgerChunker > get_chunker()=0
virtual std::vector< uint8_t > serialise_snapshot(std::unique_ptr< AbstractSnapshot > snapshot)=0
virtual Version compacted_version()=0
virtual void rollback(const ccf::TxID &tx_id, Term write_term_)=0
virtual void unlock_maps()=0
virtual ~AbstractStore()=default
virtual ApplyResult deserialise_snapshot(const uint8_t *data, size_t size, ConsensusHookPtrs &hooks, std::vector< Version > *view_history=nullptr, bool public_only=false)=0
virtual void initialise_term(Term t)=0
virtual void unset_flag_unsafe(StoreFlag f)=0
virtual std::tuple< Version, Version > next_version(bool commit_new_map)=0
virtual ccf::TxID current_txid()=0
Definition kv_types.h:477
virtual ~AbstractTxEncryptor()=default
virtual bool decrypt(const std::vector< uint8_t > &cipher, const std::vector< uint8_t > &additional_data, const std::vector< uint8_t > &serialised_header, std::vector< uint8_t > &plain, Version version, Term &term, bool historical_hint=false)=0
virtual size_t get_header_length()=0
virtual bool encrypt(const std::vector< uint8_t > &plain, const std::vector< uint8_t > &additional_data, std::vector< uint8_t > &serialised_header, std::vector< uint8_t > &cipher, const ccf::TxID &tx_id, EntryType entry_type=EntryType::WriteSet, bool historical_hint=false)=0
virtual void rollback(Version version)=0
virtual uint64_t get_term(const uint8_t *data, size_t size)=0
virtual ccf::crypto::HashBytes get_commit_nonce(const ccf::TxID &tx_id, bool historical_hint=false)=0
Definition kv_types.h:191
virtual void add_configuration(ccf::SeqNo seqno, const Configuration::Nodes &conf)=0
virtual ~ConfigurableConsensus()=default
virtual ConsensusDetails get_details()=0
virtual Configuration::Nodes get_latest_configuration()=0
virtual Configuration::Nodes get_latest_configuration_unsafe() const =0
Definition kv_types.h:364
virtual void enable_all_domains()
Definition kv_types.h:407
virtual void nominate_successor()
Definition kv_types.h:413
virtual std::pair< ccf::View, ccf::SeqNo > get_committed_txid()=0
virtual bool is_candidate()=0
virtual ccf::SeqNo get_committed_seqno()=0
virtual bool can_replicate()=0
virtual void periodic_end()
Definition kv_types.h:405
~Consensus() override=default
virtual void init_as_backup(ccf::SeqNo, ccf::View, const std::vector< ccf::SeqNo > &, ccf::SeqNo)=0
virtual std::vector< ccf::SeqNo > get_view_history(ccf::SeqNo seqno=std::numeric_limits< ccf::SeqNo >::max())=0
virtual void recv_message(const NodeId &from, const uint8_t *data, size_t size)=0
virtual bool is_primary()=0
virtual std::optional< NodeId > primary()=0
virtual void force_become_primary(ccf::SeqNo, ccf::View, const std::vector< ccf::SeqNo > &, ccf::SeqNo)=0
virtual bool replicate(const BatchVector &entries, ccf::View view)=0
virtual void set_retired_committed(ccf::SeqNo, const std::vector< NodeId > &node_ids)
Definition kv_types.h:409
virtual void force_become_primary()=0
virtual bool is_at_max_capacity()=0
virtual SignatureDisposition get_signature_disposition()=0
virtual void periodic(std::chrono::milliseconds)
Definition kv_types.h:404
SignatureDisposition
Definition kv_types.h:376
virtual ccf::View get_view(ccf::SeqNo seqno)=0
virtual std::vector< ccf::SeqNo > get_view_history_since(ccf::SeqNo seqno)=0
virtual ccf::View get_view()=0
virtual bool is_backup()=0
Definition generic_serialise_wrapper.h:20
Definition kv_types.h:315
KvSerialiserException(std::string msg_)
Definition kv_types.h:320
const char * what() const noexcept override
Definition kv_types.h:322
Definition kv_types.h:446
MovePendingTx(std::vector< uint8_t > &&data_, ccf::ClaimsDigest &&claims_digest_, ccf::crypto::Sha256Hash &&commit_evidence_digest_, ConsensusHookPtrs &&hooks_)
Definition kv_types.h:454
PendingTxInfo call() override
Definition kv_types.h:465
Definition kv_types.h:439
virtual ~PendingTx()=default
virtual PendingTxInfo call()=0
Definition kv_types.h:693
ScopedStoreMapsLock()=delete
ScopedStoreMapsLock(StorePointer _store)
Definition kv_types.h:696
~ScopedStoreMapsLock()
Definition kv_types.h:700
Definition kv_types.h:329
virtual void compact(Version v)=0
virtual void set_term(ccf::kv::Term)=0
virtual std::vector< uint8_t > get_proof(Version v)=0
virtual void emit_signature()=0
virtual const ccf::COSESignaturesConfig & get_cose_signatures_config()=0
virtual bool verify_root_signatures(ccf::kv::Version version)=0
virtual bool init_from_snapshot(const std::vector< uint8_t > &hash_at_snapshot)=0
virtual std::vector< uint8_t > serialise_tree(size_t to)=0
virtual std::vector< uint8_t > get_raw_leaf(uint64_t index)=0
virtual void set_service_signing_identity(std::shared_ptr< ccf::crypto::ECKeyPair_OpenSSL > keypair, const COSESignaturesConfig &cose_signatures)=0
virtual void try_emit_signature()=0
virtual ccf::crypto::Sha256Hash get_replicated_state_root()=0
virtual void append_entry(const ccf::crypto::Sha256Hash &digest, std::optional< ccf::kv::Term > expected_term=std::nullopt)=0
virtual void append(const std::vector< uint8_t > &data)=0
virtual void start_signature_emit_timer()=0
virtual bool verify_proof(const std::vector< uint8_t > &proof)=0
virtual void rollback(const ccf::TxID &tx_id, ccf::kv::Term term_of_next_version_)=0
virtual std::tuple< ccf::TxID, ccf::crypto::Sha256Hash, ccf::kv::Term > get_replicated_state_txid_and_root()=0
virtual ~TxHistory()=default
virtual void set_endorsed_certificate(const ccf::crypto::Pem &cert)=0
#define DECLARE_JSON_REQUIRED_FIELDS(TYPE,...)
Definition json.h:718
#define DECLARE_JSON_TYPE(TYPE)
Definition json.h:667
#define DECLARE_JSON_TYPE_WITH_OPTIONAL_FIELDS(TYPE)
Definition json.h:694
#define DECLARE_JSON_OPTIONAL_FIELDS(TYPE,...)
Definition json.h:790
#define DECLARE_JSON_ENUM(TYPE,...)
Definition json.h:841
std::vector< uint8_t > HashBytes
Definition hash_bytes.h:10
Definition app_interface.h:19
std::shared_ptr< AbstractTxEncryptor > EncryptorPtr
Definition kv_types.h:506
std::string schema_name(const Configuration::NodeInfo *)
Definition kv_types.h:88
AccessCategory
Definition kv_types.h:223
@ INTERNAL
Definition kv_types.h:224
@ APPLICATION
Definition kv_types.h:226
@ GOVERNANCE
Definition kv_types.h:225
uint64_t Term
Definition kv_types.h:43
std::unique_ptr< ConsensusHook > ConsensusHookPtr
Definition hooks.h:21
EntryType
Definition kv_types.h:230
@ WriteSetWithCommitEvidenceAndClaims
@ WriteSetWithCommitEvidence
std::vector< std::tuple< Version, std::shared_ptr< std::vector< uint8_t > >, bool, std::shared_ptr< ConsensusHookPtrs > > > BatchVector
Definition kv_types.h:206
CommitResult
Definition kv_types.h:209
@ FAIL_NO_REPLICATE
Definition kv_types.h:212
@ SUCCESS
Definition kv_types.h:210
@ FAIL_CONFLICT
Definition kv_types.h:211
SecurityDomain
Definition kv_types.h:216
@ SECURITY_DOMAIN_MAX
Definition kv_types.h:219
@ PRIVATE
Definition kv_types.h:218
@ PUBLIC
Definition kv_types.h:217
uint64_t Version
Definition version.h:8
MembershipState
Definition kv_types.h:122
std::shared_ptr< AbstractSnapshotter > SnapshotterPtr
Definition kv_types.h:517
RetirementPhase
Definition kv_types.h:133
void fill_json_schema(nlohmann::json &schema, const Configuration::NodeInfo *)
Definition kv_types.h:93
uint64_t ReconfigurationId
Definition kv_types.h:46
LeadershipState
Definition kv_types.h:105
constexpr auto public_domain_prefix
Definition kv_types.h:255
void to_json(nlohmann::json &j, const Configuration::NodeInfo &ni)
Definition kv_types.h:75
ApplyResult
Definition kv_types.h:302
@ PASS_NONCES
Definition kv_types.h:307
@ PASS_SIGNATURE
Definition kv_types.h:304
@ PASS_BACKUP_SIGNATURE
Definition kv_types.h:305
@ PASS_BACKUP_SIGNATURE_SEND_ACK
Definition kv_types.h:306
@ FAIL
Definition kv_types.h:311
@ PASS
Definition kv_types.h:303
@ PASS_APPLY
Definition kv_types.h:310
@ PASS_ENCRYPTED_PAST_LEDGER_SECRET
Definition kv_types.h:309
@ PASS_NEW_VIEW
Definition kv_types.h:308
std::vector< ConsensusHookPtr > ConsensusHookPtrs
Definition hooks.h:22
void from_json(const nlohmann::json &j, Configuration::NodeInfo &ni)
Definition kv_types.h:80
Definition app_interface.h:14
EntityId< NodeIdFormatter > NodeId
Definition entity_id.h:164
view
Definition signatures.h:54
seqno
Definition signatures.h:54
uint64_t View
Definition tx_id.h:23
uint64_t SeqNo
Definition tx_id.h:36
Definition map_serializers.h:11
Definition cose_signatures_config.h:12
std::string hostname
Definition kv_types.h:52
bool operator==(const NodeInfo &other) const
Definition kv_types.h:62
NodeInfo(std::string hostname_, std::string port_)
Definition kv_types.h:57
std::string port
Definition kv_types.h:53
ccf::SeqNo idx
Definition kv_types.h:70
std::map< NodeId, NodeInfo > Nodes
Definition kv_types.h:68
ReconfigurationId rid
Definition kv_types.h:72
Nodes nodes
Definition kv_types.h:71
Definition kv_types.h:153
size_t last_received_ms
Definition kv_types.h:155
ccf::SeqNo seqno
Definition kv_types.h:154
Definition kv_types.h:151
bool ticking
Definition kv_types.h:168
std::optional< std::unordered_map< ccf::NodeId, ccf::SeqNo > > learners
Definition kv_types.h:163
std::optional< ccf::ReconfigurationType > reconfiguration_type
Definition kv_types.h:165
std::optional< RetirementPhase > retirement_phase
Definition kv_types.h:162
ccf::View current_view
Definition kv_types.h:167
std::optional< LeadershipState > leadership_state
Definition kv_types.h:161
MembershipState membership_state
Definition kv_types.h:160
std::unordered_map< ccf::NodeId, Ack > acks
Definition kv_types.h:159
std::optional< ccf::NodeId > primary_id
Definition kv_types.h:166
std::vector< Configuration > configs
Definition kv_types.h:158
GetName(std::string s)
Definition get_name.h:15
Definition kv_types.h:417
ccf::crypto::Sha256Hash commit_evidence_digest
Definition kv_types.h:421
PendingTxInfo(CommitResult success_, std::vector< uint8_t > &&data_, ccf::ClaimsDigest &&claims_digest_, ccf::crypto::Sha256Hash &&commit_evidence_digest_, std::vector< ConsensusHookPtr > &&hooks_)
Definition kv_types.h:424
std::vector< ConsensusHookPtr > hooks
Definition kv_types.h:422
ccf::ClaimsDigest claims_digest
Definition kv_types.h:420
std::vector< uint8_t > data
Definition kv_types.h:419
CommitResult success
Definition kv_types.h:418