Monero
Public Types | Public Member Functions | Protected Attributes | List of all members
hw::device Class Referenceabstract

#include <device.hpp>

Inheritance diagram for hw::device:
Inheritance graph
[legend]

Public Types

enum  device_mode { NONE, TRANSACTION_CREATE_REAL, TRANSACTION_CREATE_FAKE, TRANSACTION_PARSE }
 
enum  device_type { SOFTWARE = 0, LEDGER = 1 }
 

Public Member Functions

 device ()
 
 device (const device &hwdev)
 
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)=0
 
virtual device_type get_type () const =0
 
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_keyget_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
 
rct::key scalarmultKey (const rct::key &P, const rct::key &a)
 
rct::key scalarmultBase (const rct::key &a)
 
virtual bool open_tx (crypto::secret_key &tx_key)=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 bool ecdhEncode (rct::ecdhTuple &unmasked, const rct::key &sharedSec)=0
 
virtual bool ecdhDecode (rct::ecdhTuple &masked, const rct::key &sharedSec)=0
 
virtual bool add_output_key_mapping (const crypto::public_key &Aout, const crypto::public_key &Bout, const bool is_subaddress, const size_t real_output_index, const rct::key &amount_key, const crypto::public_key &out_eph_public_key)=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 close_tx (void)=0
 

Protected Attributes

std::string name
 

Member Enumeration Documentation

◆ device_mode

Enumerator
NONE 
TRANSACTION_CREATE_REAL 
TRANSACTION_CREATE_FAKE 
TRANSACTION_PARSE 

◆ device_type

Enumerator
SOFTWARE 
LEDGER 

Constructor & Destructor Documentation

◆ device() [1/2]

hw::device::device ( )
inline

◆ device() [2/2]

hw::device::device ( const device hwdev)
inline

◆ ~device()

virtual hw::device::~device ( )
inlinevirtual

Member Function Documentation

◆ add_output_key_mapping()

virtual bool hw::device::add_output_key_mapping ( const crypto::public_key Aout,
const crypto::public_key Bout,
const bool  is_subaddress,
const size_t  real_output_index,
const rct::key amount_key,
const crypto::public_key out_eph_public_key 
)
pure virtual

Implemented in hw::core::device_default.

◆ close_tx()

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

Implemented in hw::core::device_default.

◆ 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.

◆ disconnect()

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

Implemented in hw::core::device_default.

◆ ecdhDecode()

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

Implemented in hw::core::device_default.

◆ ecdhEncode()

virtual bool hw::device::ecdhEncode ( rct::ecdhTuple unmasked,
const rct::key sharedSec 
)
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.

◆ 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.

◆ 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_type()

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

Implemented in hw::core::device_default.

◆ 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]

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

Implemented in hw::core::device_default.

◆ scalarmultBase() [2/2]

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

◆ scalarmultKey() [1/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.

◆ scalarmultKey() [2/2]

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

◆ 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_mode()

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

Implemented 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.

◆ 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

◆ name

std::string hw::device::name
protected

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