#include <multisig_account.h>

Collaboration diagram for multisig::multisig_account:

Public Member Functions
	multisig_account ()=default
	multisig_account (const crypto::secret_key &base_privkey, const crypto::secret_key &base_common_privkey)
	multisig_account (const std::uint32_t threshold, std::vector< crypto::public_key > signers, const crypto::secret_key &base_privkey, const crypto::secret_key &base_common_privkey, std::vector< crypto::secret_key > multisig_privkeys, const crypto::secret_key &common_privkey, const crypto::public_key &multisig_pubkey, const crypto::public_key &common_pubkey, const std::uint32_t kex_rounds_complete, multisig_keyset_map_memsafe_t kex_origins_map, std::string next_round_kex_message)
	~multisig_account ()=default
std::uint32_t	get_threshold () const
const std::vector< crypto::public_key > &	get_signers () const
const crypto::secret_key &	get_base_privkey () const
const crypto::public_key &	get_base_pubkey () const
const crypto::secret_key &	get_base_common_privkey () const
const std::vector< crypto::secret_key > &	get_multisig_privkeys () const
const crypto::secret_key &	get_common_privkey () const
const crypto::public_key &	get_multisig_pubkey () const
const crypto::public_key &	get_common_pubkey () const
std::uint32_t	get_kex_rounds_complete () const
const multisig_keyset_map_memsafe_t &	get_kex_keys_to_origins_map () const
const std::string &	get_next_kex_round_msg () const
bool	account_is_active () const
bool	main_kex_rounds_done () const
bool	multisig_is_ready () const
void	initialize_kex (const std::uint32_t threshold, std::vector< crypto::public_key > signers, const std::vector< multisig_kex_msg > &expanded_msgs_rnd1)
void	kex_update (const std::vector< multisig_kex_msg > &expanded_msgs, const bool force_update_use_with_caution=false)

Private Member Functions
void	set_multisig_config (const std::size_t threshold, std::vector< crypto::public_key > signers)
void	kex_update_impl (const std::vector< multisig_kex_msg > &expanded_msgs, const bool incomplete_signer_set)
void	initialize_kex_update (const std::vector< multisig_kex_msg > &expanded_msgs, const std::uint32_t kex_rounds_required, std::vector< crypto::public_key > &exclude_pubkeys_out)
void	finalize_kex_update (const std::uint32_t kex_rounds_required, multisig_keyset_map_memsafe_t result_keys_to_origins_map)

Private Attributes
std::uint32_t	m_threshold {0}
	misc. account details
std::vector< crypto::public_key >	m_signers
crypto::secret_key	m_base_privkey
	local participant's personal keys
crypto::public_key	m_base_pubkey
crypto::secret_key	m_base_common_privkey
std::vector< crypto::secret_key >	m_multisig_privkeys
	core multisig account keys
crypto::secret_key	m_common_privkey
crypto::public_key	m_multisig_pubkey
crypto::public_key	m_common_pubkey
std::uint32_t	m_kex_rounds_complete {0}
	kex variables
multisig_keyset_map_memsafe_t	m_kex_keys_to_origins_map
std::string	m_next_round_kex_message

Constructor & Destructor Documentation

◆ multisig_account() [1/3]

multisig::multisig_account::multisig_account ( )

default

◆ multisig_account() [2/3]

multisig::multisig_account::multisig_account	(	const crypto::secret_key &	base_privkey,
		const crypto::secret_key &	base_common_privkey )

construct from base privkeys

prepares a kex msg for the first round of multisig key construction.
- the local account's kex msgs are signed with the base_privkey
- the first kex msg transmits the local base_common_privkey to other participants, for creating the group's common_privkey

◆ multisig_account() [3/3]

multisig::multisig_account::multisig_account	(	const std::uint32_t	threshold,
		std::vector< crypto::public_key >	signers,
		const crypto::secret_key &	base_privkey,
		const crypto::secret_key &	base_common_privkey,
		std::vector< crypto::secret_key >	multisig_privkeys,
		const crypto::secret_key &	common_privkey,
		const crypto::public_key &	multisig_pubkey,
		const crypto::public_key &	common_pubkey,
		const std::uint32_t	kex_rounds_complete,
		multisig_keyset_map_memsafe_t	kex_origins_map,
		std::string	next_round_kex_message )

◆ ~multisig_account()

multisig::multisig_account::~multisig_account ( )

default

Member Function Documentation

◆ account_is_active()

bool multisig::multisig_account::account_is_active ( ) const

◆ finalize_kex_update()

void multisig::multisig_account::finalize_kex_update	(	const std::uint32_t	kex_rounds_required,
		multisig_keyset_map_memsafe_t	result_keys_to_origins_map )

private

brief: finalize_kex_update - Helper for kex_update_impl() param: kex_rounds_required - number of rounds required for kex (not including post-kex verification round) param: result_keys_to_origins_map - map between keys for the next round and the other participants they correspond to inoutparam: temp_account_inout - account to perform last update steps on

◆ get_base_common_privkey()

const crypto::secret_key & multisig::multisig_account::get_base_common_privkey ( ) const

inline

◆ get_base_privkey()

const crypto::secret_key & multisig::multisig_account::get_base_privkey ( ) const

inline

◆ get_base_pubkey()

const crypto::public_key & multisig::multisig_account::get_base_pubkey ( ) const

inline

◆ get_common_privkey()

const crypto::secret_key & multisig::multisig_account::get_common_privkey ( ) const

inline

◆ get_common_pubkey()

const crypto::public_key & multisig::multisig_account::get_common_pubkey ( ) const

inline

◆ get_kex_keys_to_origins_map()

const multisig_keyset_map_memsafe_t & multisig::multisig_account::get_kex_keys_to_origins_map ( ) const

inline

◆ get_kex_rounds_complete()

std::uint32_t multisig::multisig_account::get_kex_rounds_complete ( ) const

inline

◆ get_multisig_privkeys()

const std::vector< crypto::secret_key > & multisig::multisig_account::get_multisig_privkeys ( ) const

inline

◆ get_multisig_pubkey()

const crypto::public_key & multisig::multisig_account::get_multisig_pubkey ( ) const

inline

◆ get_next_kex_round_msg()

const std::string & multisig::multisig_account::get_next_kex_round_msg ( ) const

inline

◆ get_signers()

const std::vector< crypto::public_key > & multisig::multisig_account::get_signers ( ) const

inline

◆ get_threshold()

std::uint32_t multisig::multisig_account::get_threshold ( ) const

inline

◆ initialize_kex()

void multisig::multisig_account::initialize_kex	(	const std::uint32_t	threshold,
		std::vector< crypto::public_key >	signers,
		const std::vector< multisig_kex_msg > &	expanded_msgs_rnd1 )

brief: initialize_kex - initialize key exchange

Updates the account with a 'transactional' model. This account will only be mutated if the update succeeds.

◆ initialize_kex_update()

void multisig::multisig_account::initialize_kex_update	(	const std::vector< multisig_kex_msg > &	expanded_msgs,
		const std::uint32_t	kex_rounds_required,
		std::vector< crypto::public_key > &	exclude_pubkeys_out )

private

brief: initialize_kex_update - Helper for kex_update_impl()

Collect the local signer's shared keys to ignore in incoming messages, build the aggregate ancillary key if appropriate. param: expanded_msgs - set of multisig kex messages to process param: kex_rounds_required - number of rounds required for kex (not including post-kex verification round) outparam: exclude_pubkeys_out - keys held by the local account corresponding to round 'current_round'
If 'current_round' is the final round, these are the local account's shares of the final aggregate key.

◆ kex_update()

void multisig::multisig_account::kex_update	(	const std::vector< multisig_kex_msg > &	expanded_msgs,
		const bool	force_update_use_with_caution = false )

brief: kex_update - Complete the 'in progress' kex round and set the kex message for the next round.

Updates the account with a 'transactional' model. This account will only be mutated if the update succeeds.
The main interface for multisig key exchange, this handles all the work of processing input messages, creating new messages for new rounds, and finalizing the multisig shared public key when kex is complete. param: expanded_msgs - kex messages corresponding to the account's 'in progress' round param: force_update_use_with_caution - try to force the account to update with messages from an incomplete signer set.
If this is the post-kex verification round, only require one input message.
- Force updating here should only be done if we can safely assume an honest signer subgroup of size 'threshold' will complete the account.
If this is an intermediate round, only require messages from 'num signers - 1 - (round - 1)' other signers.
- If force updating with maliciously-crafted messages, the resulting account will be invalid (either unable to complete signatures, or a 'hostage' to the malicious signer [i.e. can't sign without his participation]).

◆ kex_update_impl()

void multisig::multisig_account::kex_update_impl	(	const std::vector< multisig_kex_msg > &	expanded_msgs,
		const bool	incomplete_signer_set )

private

◆ main_kex_rounds_done()

bool multisig::multisig_account::main_kex_rounds_done ( ) const

◆ multisig_is_ready()

bool multisig::multisig_account::multisig_is_ready ( ) const

◆ set_multisig_config()

void multisig::multisig_account::set_multisig_config	(	const std::size_t	threshold,
		std::vector< crypto::public_key >	signers )

private

Member Data Documentation

◆ m_base_common_privkey

crypto::secret_key multisig::multisig_account::m_base_common_privkey

private

◆ m_base_privkey

crypto::secret_key multisig::multisig_account::m_base_privkey

private

local participant's personal keys

◆ m_base_pubkey

crypto::public_key multisig::multisig_account::m_base_pubkey

private

◆ m_common_privkey

crypto::secret_key multisig::multisig_account::m_common_privkey

private

◆ m_common_pubkey

crypto::public_key multisig::multisig_account::m_common_pubkey

private

◆ m_kex_keys_to_origins_map

multisig_keyset_map_memsafe_t multisig::multisig_account::m_kex_keys_to_origins_map

private

◆ m_kex_rounds_complete

std::uint32_t multisig::multisig_account::m_kex_rounds_complete {0}

private

kex variables

◆ m_multisig_privkeys

std::vector<crypto::secret_key> multisig::multisig_account::m_multisig_privkeys

private

core multisig account keys

◆ m_multisig_pubkey

crypto::public_key multisig::multisig_account::m_multisig_pubkey

private

◆ m_next_round_kex_message

std::string multisig::multisig_account::m_next_round_kex_message

private

◆ m_signers

std::vector<crypto::public_key> multisig::multisig_account::m_signers

private

◆ m_threshold

std::uint32_t multisig::multisig_account::m_threshold {0}

private

misc. account details

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

src/multisig/multisig_account.h
src/multisig/multisig_account.cpp
src/multisig/multisig_account_kex_impl.cpp

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ multisig_account() [1/3]

◆ multisig_account() [2/3]

◆ multisig_account() [3/3]

◆ ~multisig_account()

Member Function Documentation

◆ account_is_active()

◆ finalize_kex_update()

◆ get_base_common_privkey()

◆ get_base_privkey()

◆ get_base_pubkey()

◆ get_common_privkey()

◆ get_common_pubkey()

◆ get_kex_keys_to_origins_map()

◆ get_kex_rounds_complete()

◆ get_multisig_privkeys()

◆ get_multisig_pubkey()

◆ get_next_kex_round_msg()

◆ get_signers()

◆ get_threshold()

◆ initialize_kex()

◆ initialize_kex_update()

◆ kex_update()

◆ kex_update_impl()

◆ main_kex_rounds_done()

◆ multisig_is_ready()

◆ set_multisig_config()

Member Data Documentation

◆ m_base_common_privkey

◆ m_base_privkey

◆ m_base_pubkey

◆ m_common_privkey

◆ m_common_pubkey

◆ m_kex_keys_to_origins_map

◆ m_kex_rounds_complete

◆ m_multisig_privkeys

◆ m_multisig_pubkey

◆ m_next_round_kex_message

◆ m_signers

◆ m_threshold