#include <device.hpp>

Inheritance diagram for hw::device:

Public Types
enum	device_mode { NONE , TRANSACTION_CREATE_REAL , TRANSACTION_CREATE_FAKE , TRANSACTION_PARSE }
enum	device_type { SOFTWARE = 0 , LEDGER = 1 , TREZOR = 2 }
enum	device_protocol_t { PROTOCOL_DEFAULT , PROTOCOL_PROXY , PROTOCOL_COLD }

Public Member Functions
	device ()
virtual	~device ()
virtual	operator bool () const =0
virtual bool	set_name (const std::string &name)=0
virtual const std::string	get_name () const =0
virtual bool	init (void)=0
virtual bool	release ()=0
virtual bool	connect (void)=0
virtual bool	disconnect (void)=0
virtual bool	set_mode (device_mode mode)
virtual device_mode	get_mode () const
virtual device_type	get_type () const =0
virtual device_protocol_t	device_protocol () const
virtual void	set_callback (i_device_callback *callback)
virtual void	set_derivation_path (const std::string &derivation_path)
virtual void	set_pin (const epee::wipeable_string &pin)
virtual void	set_passphrase (const epee::wipeable_string &passphrase)
virtual void	lock (void)=0
virtual void	unlock (void)=0
virtual bool	try_lock (void)=0
virtual bool	get_public_address (cryptonote::account_public_address &pubkey)=0
virtual bool	get_secret_keys (crypto::secret_key &viewkey, crypto::secret_key &spendkey)=0
virtual bool	generate_chacha_key (const cryptonote::account_keys &keys, crypto::chacha_key &key, uint64_t kdf_rounds)=0
virtual bool	derive_subaddress_public_key (const crypto::public_key &pub, const crypto::key_derivation &derivation, const std::size_t output_index, crypto::public_key &derived_pub)=0
virtual crypto::public_key	get_subaddress_spend_public_key (const cryptonote::account_keys &keys, const cryptonote::subaddress_index &index)=0
virtual std::vector< crypto::public_key >	get_subaddress_spend_public_keys (const cryptonote::account_keys &keys, uint32_t account, uint32_t begin, uint32_t end)=0
virtual cryptonote::account_public_address	get_subaddress (const cryptonote::account_keys &keys, const cryptonote::subaddress_index &index)=0
virtual crypto::secret_key	get_subaddress_secret_key (const crypto::secret_key &sec, const cryptonote::subaddress_index &index)=0
virtual bool	verify_keys (const crypto::secret_key &secret_key, const crypto::public_key &public_key)=0
virtual bool	scalarmultKey (rct::key &aP, const rct::key &P, const rct::key &a)=0
virtual bool	scalarmultBase (rct::key &aG, const rct::key &a)=0
virtual bool	sc_secret_add (crypto::secret_key &r, const crypto::secret_key &a, const crypto::secret_key &b)=0
virtual crypto::secret_key	generate_keys (crypto::public_key &pub, crypto::secret_key &sec, const crypto::secret_key &recovery_key=crypto::secret_key(), bool recover=false)=0
virtual bool	generate_key_derivation (const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation)=0
virtual bool	conceal_derivation (crypto::key_derivation &derivation, const crypto::public_key &tx_pub_key, const std::vector< crypto::public_key > &additional_tx_pub_keys, const crypto::key_derivation &main_derivation, const std::vector< crypto::key_derivation > &additional_derivations)=0
virtual bool	derivation_to_scalar (const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res)=0
virtual bool	derive_secret_key (const crypto::key_derivation &derivation, const std::size_t output_index, const crypto::secret_key &sec, crypto::secret_key &derived_sec)=0
virtual bool	derive_public_key (const crypto::key_derivation &derivation, const std::size_t output_index, const crypto::public_key &pub, crypto::public_key &derived_pub)=0
virtual bool	secret_key_to_public_key (const crypto::secret_key &sec, crypto::public_key &pub)=0
virtual bool	generate_key_image (const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_image &image)=0
virtual bool	derive_view_tag (const crypto::key_derivation &derivation, const std::size_t output_index, crypto::view_tag &view_tag)=0
rct::key	scalarmultKey (const rct::key &P, const rct::key &a)
rct::key	scalarmultBase (const rct::key &a)
virtual void	generate_tx_proof (const crypto::hash &prefix_hash, const crypto::public_key &R, const crypto::public_key &A, const boost::optional< crypto::public_key > &B, const crypto::public_key &D, const crypto::secret_key &r, crypto::signature &sig)=0
virtual bool	open_tx (crypto::secret_key &tx_key)=0
virtual void	get_transaction_prefix_hash (const cryptonote::transaction_prefix &tx, crypto::hash &h)=0
virtual bool	encrypt_payment_id (crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key)=0
bool	decrypt_payment_id (crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key)
virtual rct::key	genCommitmentMask (const rct::key &amount_key)=0
virtual bool	ecdhEncode (rct::ecdhTuple &unmasked, const rct::key &sharedSec, bool short_amount)=0
virtual bool	ecdhDecode (rct::ecdhTuple &masked, const rct::key &sharedSec, bool short_amount)=0
virtual bool	generate_output_ephemeral_keys (const size_t tx_version, const cryptonote::account_keys &sender_account_keys, const crypto::public_key &txkey_pub, const crypto::secret_key &tx_key, const cryptonote::tx_destination_entry &dst_entr, const boost::optional< cryptonote::account_public_address > &change_addr, const size_t output_index, const bool &need_additional_txkeys, const std::vector< crypto::secret_key > &additional_tx_keys, std::vector< crypto::public_key > &additional_tx_public_keys, std::vector< rct::key > &amount_keys, crypto::public_key &out_eph_public_key, const bool use_view_tags, crypto::view_tag &view_tag)=0
virtual bool	mlsag_prehash (const std::string &blob, size_t inputs_size, size_t outputs_size, const rct::keyV &hashes, const rct::ctkeyV &outPk, rct::key &prehash)=0
virtual bool	mlsag_prepare (const rct::key &H, const rct::key &xx, rct::key &a, rct::key &aG, rct::key &aHP, rct::key &rvII)=0
virtual bool	mlsag_prepare (rct::key &a, rct::key &aG)=0
virtual bool	mlsag_hash (const rct::keyV &long_message, rct::key &c)=0
virtual bool	mlsag_sign (const rct::key &c, const rct::keyV &xx, const rct::keyV &alpha, const size_t rows, const size_t dsRows, rct::keyV &ss)=0
virtual bool	clsag_prepare (const rct::key &p, const rct::key &z, rct::key &I, rct::key &D, const rct::key &H, rct::key &a, rct::key &aG, rct::key &aH)=0
virtual bool	clsag_hash (const rct::keyV &data, rct::key &hash)=0
virtual bool	clsag_sign (const rct::key &c, const rct::key &a, const rct::key &p, const rct::key &z, const rct::key &mu_P, const rct::key &mu_C, rct::key &s)=0
virtual bool	close_tx (void)=0
virtual bool	has_ki_cold_sync (void) const
virtual bool	has_tx_cold_sign (void) const
virtual bool	has_ki_live_refresh (void) const
virtual bool	compute_key_image (const cryptonote::account_keys &ack, const crypto::public_key &out_key, const crypto::key_derivation &recv_derivation, size_t real_output_index, const cryptonote::subaddress_index &received_index, cryptonote::keypair &in_ephemeral, crypto::key_image &ki)
virtual void	computing_key_images (bool started)
virtual void	set_network_type (cryptonote::network_type network_type)
virtual void	display_address (const cryptonote::subaddress_index &index, const boost::optional< crypto::hash8 > &payment_id)

Protected Attributes
std::string	name
device_mode	mode

Member Enumeration Documentation

◆ device_mode

enum hw::device::device_mode

Enumerator
NONE
TRANSACTION_CREATE_REAL
TRANSACTION_CREATE_FAKE
TRANSACTION_PARSE

◆ device_protocol_t

enum hw::device::device_protocol_t

Enumerator
PROTOCOL_DEFAULT
PROTOCOL_PROXY
PROTOCOL_COLD

◆ device_type

enum hw::device::device_type

Enumerator
SOFTWARE
LEDGER
TREZOR

Constructor & Destructor Documentation

◆ device()

hw::device::device ( )

inline

◆ ~device()

virtual hw::device::~device ( )

inlinevirtual

Member Function Documentation

◆ close_tx()

virtual bool hw::device::close_tx ( void )

pure virtual

Implemented in hw::core::device_default.

◆ clsag_hash()

virtual bool hw::device::clsag_hash	(	const rct::keyV &	data,
		rct::key &	hash )

pure virtual

Implemented in hw::core::device_default.

◆ clsag_prepare()

virtual bool hw::device::clsag_prepare	(	const rct::key &	p,
		const rct::key &	z,
		rct::key &	I,
		rct::key &	D,
		const rct::key &	H,
		rct::key &	a,
		rct::key &	aG,
		rct::key &	aH )

pure virtual

Implemented in hw::core::device_default.

◆ clsag_sign()

virtual bool hw::device::clsag_sign	(	const rct::key &	c,
		const rct::key &	a,
		const rct::key &	p,
		const rct::key &	z,
		const rct::key &	mu_P,
		const rct::key &	mu_C,
		rct::key &	s )

pure virtual

Implemented in hw::core::device_default.

◆ compute_key_image()

virtual bool hw::device::compute_key_image	(	const cryptonote::account_keys &	ack,
		const crypto::public_key &	out_key,
		const crypto::key_derivation &	recv_derivation,
		size_t	real_output_index,
		const cryptonote::subaddress_index &	received_index,
		cryptonote::keypair &	in_ephemeral,
		crypto::key_image &	ki )

inlinevirtual

◆ computing_key_images()

virtual void hw::device::computing_key_images ( bool started )

inlinevirtual

◆ conceal_derivation()

virtual bool hw::device::conceal_derivation	(	crypto::key_derivation &	derivation,
		const crypto::public_key &	tx_pub_key,
		const std::vector< crypto::public_key > &	additional_tx_pub_keys,
		const crypto::key_derivation &	main_derivation,
		const std::vector< crypto::key_derivation > &	additional_derivations )

pure virtual

Implemented in hw::core::device_default.

◆ connect()

virtual bool hw::device::connect ( void )

pure virtual

Implemented in hw::core::device_default.

◆ decrypt_payment_id()

bool hw::device::decrypt_payment_id	(	crypto::hash8 &	payment_id,
		const crypto::public_key &	public_key,
		const crypto::secret_key &	secret_key )

inline

◆ derivation_to_scalar()

virtual bool hw::device::derivation_to_scalar	(	const crypto::key_derivation &	derivation,
		const size_t	output_index,
		crypto::ec_scalar &	res )

pure virtual

Implemented in hw::core::device_default.

◆ derive_public_key()

virtual bool hw::device::derive_public_key	(	const crypto::key_derivation &	derivation,
		const std::size_t	output_index,
		const crypto::public_key &	pub,
		crypto::public_key &	derived_pub )

pure virtual

Implemented in hw::core::device_default.

◆ derive_secret_key()

virtual bool hw::device::derive_secret_key	(	const crypto::key_derivation &	derivation,
		const std::size_t	output_index,
		const crypto::secret_key &	sec,
		crypto::secret_key &	derived_sec )

pure virtual

Implemented in hw::core::device_default.

◆ derive_subaddress_public_key()

virtual bool hw::device::derive_subaddress_public_key	(	const crypto::public_key &	pub,
		const crypto::key_derivation &	derivation,
		const std::size_t	output_index,
		crypto::public_key &	derived_pub )

pure virtual

Implemented in hw::core::device_default.

◆ derive_view_tag()

virtual bool hw::device::derive_view_tag	(	const crypto::key_derivation &	derivation,
		const std::size_t	output_index,
		crypto::view_tag &	view_tag )

pure virtual

Implemented in hw::core::device_default.

◆ device_protocol()

virtual device_protocol_t hw::device::device_protocol ( ) const

inlinevirtual

◆ disconnect()

virtual bool hw::device::disconnect ( void )

pure virtual

Implemented in hw::core::device_default.

◆ display_address()

virtual void hw::device::display_address	(	const cryptonote::subaddress_index &	index,
		const boost::optional< crypto::hash8 > &	payment_id )

inlinevirtual

◆ ecdhDecode()

virtual bool hw::device::ecdhDecode	(	rct::ecdhTuple &	masked,
		const rct::key &	sharedSec,
		bool	short_amount )

pure virtual

Implemented in hw::core::device_default.

◆ ecdhEncode()

virtual bool hw::device::ecdhEncode	(	rct::ecdhTuple &	unmasked,
		const rct::key &	sharedSec,
		bool	short_amount )

pure virtual

Implemented in hw::core::device_default.

◆ encrypt_payment_id()

virtual bool hw::device::encrypt_payment_id	(	crypto::hash8 &	payment_id,
		const crypto::public_key &	public_key,
		const crypto::secret_key &	secret_key )

pure virtual

Implemented in hw::core::device_default.

◆ genCommitmentMask()

virtual rct::key hw::device::genCommitmentMask ( const rct::key & amount_key )

pure virtual

Implemented in hw::core::device_default.

◆ generate_chacha_key()

virtual bool hw::device::generate_chacha_key	(	const cryptonote::account_keys &	keys,
		crypto::chacha_key &	key,
		uint64_t	kdf_rounds )

pure virtual

Implemented in hw::core::device_default.

◆ generate_key_derivation()

virtual bool hw::device::generate_key_derivation	(	const crypto::public_key &	pub,
		const crypto::secret_key &	sec,
		crypto::key_derivation &	derivation )

pure virtual

Implemented in hw::core::device_default.

◆ generate_key_image()

virtual bool hw::device::generate_key_image	(	const crypto::public_key &	pub,
		const crypto::secret_key &	sec,
		crypto::key_image &	image )

pure virtual

Implemented in hw::core::device_default.

◆ generate_keys()

virtual crypto::secret_key hw::device::generate_keys	(	crypto::public_key &	pub,
		crypto::secret_key &	sec,
		const crypto::secret_key &	recovery_key = crypto::secret_key(),
		bool	recover = false )

pure virtual

Implemented in hw::core::device_default.

◆ generate_output_ephemeral_keys()

virtual bool hw::device::generate_output_ephemeral_keys	(	const size_t	tx_version,
		const cryptonote::account_keys &	sender_account_keys,
		const crypto::public_key &	txkey_pub,
		const crypto::secret_key &	tx_key,
		const cryptonote::tx_destination_entry &	dst_entr,
		const boost::optional< cryptonote::account_public_address > &	change_addr,
		const size_t	output_index,
		const bool &	need_additional_txkeys,
		const std::vector< crypto::secret_key > &	additional_tx_keys,
		std::vector< crypto::public_key > &	additional_tx_public_keys,
		std::vector< rct::key > &	amount_keys,
		crypto::public_key &	out_eph_public_key,
		const bool	use_view_tags,
		crypto::view_tag &	view_tag )

pure virtual

Implemented in hw::core::device_default.

◆ generate_tx_proof()

virtual void hw::device::generate_tx_proof	(	const crypto::hash &	prefix_hash,
		const crypto::public_key &	R,
		const crypto::public_key &	A,
		const boost::optional< crypto::public_key > &	B,
		const crypto::public_key &	D,
		const crypto::secret_key &	r,
		crypto::signature &	sig )

pure virtual

Implemented in hw::core::device_default.

◆ get_mode()

virtual device_mode hw::device::get_mode ( ) const

inlinevirtual

◆ get_name()

virtual const std::string hw::device::get_name ( ) const

pure virtual

Implemented in hw::core::device_default.

◆ get_public_address()

virtual bool hw::device::get_public_address ( cryptonote::account_public_address & pubkey )

pure virtual

Implemented in hw::core::device_default.

◆ get_secret_keys()

virtual bool hw::device::get_secret_keys	(	crypto::secret_key &	viewkey,
		crypto::secret_key &	spendkey )

pure virtual

Implemented in hw::core::device_default.

◆ get_subaddress()

virtual cryptonote::account_public_address hw::device::get_subaddress	(	const cryptonote::account_keys &	keys,
		const cryptonote::subaddress_index &	index )

pure virtual

Implemented in hw::core::device_default.

◆ get_subaddress_secret_key()

virtual crypto::secret_key hw::device::get_subaddress_secret_key	(	const crypto::secret_key &	sec,
		const cryptonote::subaddress_index &	index )

pure virtual

Implemented in hw::core::device_default.

◆ get_subaddress_spend_public_key()

virtual crypto::public_key hw::device::get_subaddress_spend_public_key	(	const cryptonote::account_keys &	keys,
		const cryptonote::subaddress_index &	index )

pure virtual

Implemented in hw::core::device_default.

◆ get_subaddress_spend_public_keys()

virtual std::vector< crypto::public_key > hw::device::get_subaddress_spend_public_keys	(	const cryptonote::account_keys &	keys,
		uint32_t	account,
		uint32_t	begin,
		uint32_t	end )

pure virtual

Implemented in hw::core::device_default.

◆ get_transaction_prefix_hash()

virtual void hw::device::get_transaction_prefix_hash	(	const cryptonote::transaction_prefix &	tx,
		crypto::hash &	h )

pure virtual

Implemented in hw::core::device_default.

◆ get_type()

virtual device_type hw::device::get_type ( ) const

pure virtual

Implemented in hw::core::device_default.

◆ has_ki_cold_sync()

virtual bool hw::device::has_ki_cold_sync ( void ) const

inlinevirtual

◆ has_ki_live_refresh()

virtual bool hw::device::has_ki_live_refresh ( void ) const

inlinevirtual

◆ has_tx_cold_sign()

virtual bool hw::device::has_tx_cold_sign ( void ) const

inlinevirtual

◆ init()

virtual bool hw::device::init ( void )

pure virtual

Implemented in hw::core::device_default.

◆ lock()

virtual void hw::device::lock ( void )

pure virtual

Implemented in hw::core::device_default.

◆ mlsag_hash()

virtual bool hw::device::mlsag_hash	(	const rct::keyV &	long_message,
		rct::key &	c )

pure virtual

Implemented in hw::core::device_default.

◆ mlsag_prehash()

virtual bool hw::device::mlsag_prehash	(	const std::string &	blob,
		size_t	inputs_size,
		size_t	outputs_size,
		const rct::keyV &	hashes,
		const rct::ctkeyV &	outPk,
		rct::key &	prehash )

pure virtual

Implemented in hw::core::device_default.

◆ mlsag_prepare() [1/2]

virtual bool hw::device::mlsag_prepare	(	const rct::key &	H,
		const rct::key &	xx,
		rct::key &	a,
		rct::key &	aG,
		rct::key &	aHP,
		rct::key &	rvII )

pure virtual

Implemented in hw::core::device_default.

◆ mlsag_prepare() [2/2]

virtual bool hw::device::mlsag_prepare	(	rct::key &	a,
		rct::key &	aG )

pure virtual

Implemented in hw::core::device_default.

◆ mlsag_sign()

virtual bool hw::device::mlsag_sign	(	const rct::key &	c,
		const rct::keyV &	xx,
		const rct::keyV &	alpha,
		const size_t	rows,
		const size_t	dsRows,
		rct::keyV &	ss )

pure virtual

Implemented in hw::core::device_default.

◆ open_tx()

virtual bool hw::device::open_tx ( crypto::secret_key & tx_key )

pure virtual

Implemented in hw::core::device_default.

◆ operator bool()

virtual hw::device::operator bool ( ) const

explicitpure virtual

Implemented in hw::core::device_default.

◆ release()

virtual bool hw::device::release ( )

pure virtual

Implemented in hw::core::device_default.

◆ sc_secret_add()

virtual bool hw::device::sc_secret_add	(	crypto::secret_key &	r,
		const crypto::secret_key &	a,
		const crypto::secret_key &	b )

pure virtual

Implemented in hw::core::device_default.

◆ scalarmultBase() [1/2]

rct::key hw::device::scalarmultBase ( const rct::key & a )

inline

◆ scalarmultBase() [2/2]

virtual bool hw::device::scalarmultBase	(	rct::key &	aG,
		const rct::key &	a )

pure virtual

Implemented in hw::core::device_default.

◆ scalarmultKey() [1/2]

rct::key hw::device::scalarmultKey	(	const rct::key &	P,
		const rct::key &	a )

inline

◆ scalarmultKey() [2/2]

virtual bool hw::device::scalarmultKey	(	rct::key &	aP,
		const rct::key &	P,
		const rct::key &	a )

pure virtual

Implemented in hw::core::device_default.

◆ secret_key_to_public_key()

virtual bool hw::device::secret_key_to_public_key	(	const crypto::secret_key &	sec,
		crypto::public_key &	pub )

pure virtual

Implemented in hw::core::device_default.

◆ set_callback()

virtual void hw::device::set_callback ( i_device_callback * callback )

inlinevirtual

◆ set_derivation_path()

virtual void hw::device::set_derivation_path ( const std::string & derivation_path )

inlinevirtual

◆ set_mode()

virtual bool hw::device::set_mode ( device_mode mode )

inlinevirtual

Reimplemented in hw::core::device_default.

◆ set_name()

virtual bool hw::device::set_name ( const std::string & name )

pure virtual

Implemented in hw::core::device_default.

◆ set_network_type()

virtual void hw::device::set_network_type ( cryptonote::network_type network_type )

inlinevirtual

◆ set_passphrase()

virtual void hw::device::set_passphrase ( const epee::wipeable_string & passphrase )

inlinevirtual

◆ set_pin()

virtual void hw::device::set_pin ( const epee::wipeable_string & pin )

inlinevirtual

◆ try_lock()

virtual bool hw::device::try_lock ( void )

pure virtual

Implemented in hw::core::device_default.

◆ unlock()

virtual void hw::device::unlock ( void )

pure virtual

Implemented in hw::core::device_default.

◆ verify_keys()

virtual bool hw::device::verify_keys	(	const crypto::secret_key &	secret_key,
		const crypto::public_key &	public_key )

pure virtual

Implemented in hw::core::device_default.

Member Data Documentation

◆ mode

device_mode hw::device::mode

protected

◆ name

std::string hw::device::name

protected

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

src/device/device.hpp

Public Types

Public Member Functions

Protected Attributes

Member Enumeration Documentation

◆ device_mode

◆ device_protocol_t

◆ device_type

Constructor & Destructor Documentation

◆ device()

◆ ~device()

Member Function Documentation

◆ close_tx()

◆ clsag_hash()

◆ clsag_prepare()

◆ clsag_sign()

◆ compute_key_image()

◆ computing_key_images()

◆ conceal_derivation()

◆ connect()

◆ decrypt_payment_id()

◆ derivation_to_scalar()

◆ derive_public_key()

◆ derive_secret_key()

◆ derive_subaddress_public_key()

◆ derive_view_tag()

◆ device_protocol()

◆ disconnect()

◆ display_address()

◆ ecdhDecode()

◆ ecdhEncode()

◆ encrypt_payment_id()

◆ genCommitmentMask()

◆ generate_chacha_key()

◆ generate_key_derivation()

◆ generate_key_image()

◆ generate_keys()

◆ generate_output_ephemeral_keys()

◆ generate_tx_proof()

◆ get_mode()

◆ get_name()

◆ get_public_address()

◆ get_secret_keys()

◆ get_subaddress()

◆ get_subaddress_secret_key()

◆ get_subaddress_spend_public_key()

◆ get_subaddress_spend_public_keys()

◆ get_transaction_prefix_hash()

◆ get_type()

◆ has_ki_cold_sync()

◆ has_ki_live_refresh()

◆ has_tx_cold_sign()

◆ init()

◆ lock()

◆ mlsag_hash()

◆ mlsag_prehash()

◆ mlsag_prepare() [1/2]

◆ mlsag_prepare() [2/2]

◆ mlsag_sign()

◆ open_tx()

◆ operator bool()

◆ release()

◆ sc_secret_add()

◆ scalarmultBase() [1/2]

◆ scalarmultBase() [2/2]

◆ scalarmultKey() [1/2]

◆ scalarmultKey() [2/2]

◆ secret_key_to_public_key()

◆ set_callback()

◆ set_derivation_path()

◆ set_mode()

◆ set_name()

◆ set_network_type()

◆ set_passphrase()

◆ set_pin()

◆ try_lock()

◆ unlock()

◆ verify_keys()

Member Data Documentation

◆ mode

◆ name