Electroneum
device.hpp
Go to the documentation of this file.
1 // Copyright (c) 2017-2019, The Monero Project
2 //
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are
6 // permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice, this list of
9 // conditions and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 // of conditions and the following disclaimer in the documentation and/or other
13 // materials provided with the distribution.
14 //
15 // 3. Neither the name of the copyright holder nor the names of its contributors may be
16 // used to endorse or promote products derived from this software without specific
17 // prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 //
29 
30 #pragma once
31 
32 #include "crypto/crypto.h"
33 #include "crypto/chacha.h"
34 #include "ringct/rctTypes.h"
35 #include "cryptonote_config.h"
36 
37 
38 #ifndef USE_DEVICE_LEDGER
39 #define USE_DEVICE_LEDGER 1
40 #endif
41 
42 #if !defined(HAVE_HIDAPI)
43 #undef USE_DEVICE_LEDGER
44 #define USE_DEVICE_LEDGER 0
45 #endif
46 
47 #if USE_DEVICE_LEDGER
48 #define WITH_DEVICE_LEDGER
49 #endif
50 
51 // forward declaration needed because this header is included by headers in libcryptonote_basic which depends on libdevice
52 namespace cryptonote
53 {
54  struct account_public_address;
55  struct account_keys;
56  struct subaddress_index;
57  struct tx_destination_entry;
58  struct keypair;
59  class transaction_prefix;
60 }
61 
62 namespace hw {
63  namespace {
64  //device funcion not supported
65  #define dfns() \
66  throw std::runtime_error(std::string("device function not supported: ")+ std::string(__FUNCTION__) + \
67  std::string(" (device.hpp line ")+std::to_string(__LINE__)+std::string(").")); \
68  return false;
69  }
70 
72  public:
73  virtual double progress() const { return 0; }
74  virtual bool indeterminate() const { return false; }
75  };
76 
78  public:
79  virtual void on_button_request(uint64_t code=0) {}
80  virtual void on_button_pressed() {}
81  virtual boost::optional<epee::wipeable_string> on_pin_request() { return boost::none; }
82  virtual boost::optional<epee::wipeable_string> on_passphrase_request(bool on_device) { return boost::none; }
83  virtual void on_progress(const device_progress& event) {}
84  virtual ~i_device_callback() = default;
85  };
86 
87  class device {
88  protected:
90 
91  public:
92 
93  device(): mode(NONE) {}
94  device(const device &hwdev) {}
95  virtual ~device() {}
96 
97  explicit virtual operator bool() const = 0;
98  enum device_mode {
103  };
105  {
106  SOFTWARE = 0,
107  LEDGER = 1,
108  TREZOR = 2
109  };
110 
111 
114  PROTOCOL_PROXY, // Originally defined by Ledger
115  PROTOCOL_COLD, // Originally defined by Trezor
116  };
117 
118  /* ======================================================================= */
119  /* SETUP/TEARDOWN */
120  /* ======================================================================= */
121  virtual bool set_name(const std::string &name) = 0;
122  virtual const std::string get_name() const = 0;
123 
124  virtual bool init(void) = 0;
125  virtual bool release() = 0;
126 
127  virtual bool connect(void) = 0;
128  virtual bool disconnect(void) = 0;
129 
130  virtual bool set_mode(device_mode mode) { this->mode = mode; return true; }
131  virtual device_mode get_mode() const { return mode; }
132 
133  virtual device_type get_type() const = 0;
134 
136  virtual void set_callback(i_device_callback * callback) {};
137  virtual void set_derivation_path(const std::string &derivation_path) {};
138 
139  virtual void set_pin(const epee::wipeable_string & pin) {}
140  virtual void set_passphrase(const epee::wipeable_string & passphrase) {}
141 
142  /* ======================================================================= */
143  /* LOCKER */
144  /* ======================================================================= */
145  virtual void lock(void) = 0;
146  virtual void unlock(void) = 0;
147  virtual bool try_lock(void) = 0;
148 
149 
150  /* ======================================================================= */
151  /* WALLET & ADDRESS */
152  /* ======================================================================= */
153  virtual bool get_public_address(cryptonote::account_public_address &pubkey) = 0;
154  virtual bool get_secret_keys(crypto::secret_key &viewkey , crypto::secret_key &spendkey) = 0;
155  virtual bool generate_chacha_key(const cryptonote::account_keys &keys, crypto::chacha_key &key, uint64_t kdf_rounds) = 0;
156 
157  /* ======================================================================= */
158  /* SUB ADDRESS */
159  /* ======================================================================= */
160  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;
162  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;
165  virtual crypto::secret_key get_subaddress_private_viewkey(const crypto::secret_key &main_wallet_sec_view, crypto::secret_key &subaddress_sec_spend) = 0;
167 
168  /* ======================================================================= */
169  /* DERIVATION & KEY */
170  /* ======================================================================= */
171  virtual bool verify_keys(const crypto::secret_key &secret_key, const crypto::public_key &public_key) = 0;
172  virtual bool scalarmultKey(rct::key & aP, const rct::key &P, const rct::key &a) = 0;
173  virtual bool scalarmultBase(rct::key &aG, const rct::key &a) = 0;
174  virtual bool sc_secret_add( crypto::secret_key &r, const crypto::secret_key &a, const crypto::secret_key &b) = 0;
175  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;
176  virtual bool generate_key_derivation(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation) = 0;
177  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;
178  virtual bool derivation_to_scalar(const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res) = 0;
179  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;
180  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;
181  virtual bool secret_key_to_public_key(const crypto::secret_key &sec, crypto::public_key &pub) = 0;
182  virtual bool generate_key_image(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_image &image) = 0;
183 
184  // alternative prototypes available in libringct
186  {
187  rct::key aP;
188  scalarmultKey(aP, P, a);
189  return aP;
190  }
191 
193  {
194  rct::key aG;
195  scalarmultBase(aG, a);
196  return aG;
197  }
198 
199  /* ======================================================================= */
200  /* TRANSACTION */
201  /* ======================================================================= */
202 
203  virtual void generate_tx_proof(const crypto::hash &prefix_hash,
204  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,
205  crypto::signature &sig) = 0;
206 
207  virtual bool open_tx(crypto::secret_key &tx_key) = 0;
208 
209  virtual bool encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) = 0;
211  {
212  // Encryption and decryption are the same operation (xor with a key)
213  return encrypt_payment_id(payment_id, public_key, secret_key);
214  }
215 
216  virtual rct::key genCommitmentMask(const rct::key &amount_key) = 0;
217 
218  virtual bool ecdhEncode(rct::ecdhTuple & unmasked, const rct::key & sharedSec, bool short_amount) = 0;
219  virtual bool ecdhDecode(rct::ecdhTuple & masked, const rct::key & sharedSec, bool short_amount) = 0;
220 
221  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,
222  const cryptonote::tx_destination_entry &dst_entr, const boost::optional<cryptonote::account_public_address> &change_addr, const size_t output_index,
223  const bool &need_additional_txkeys, const std::vector<crypto::secret_key> &additional_tx_keys,
224  std::vector<crypto::public_key> &additional_tx_public_keys,
225  std::vector<rct::key> &amount_keys,
226  crypto::public_key &out_eph_public_key) = 0;
227 
228  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;
229  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;
230  virtual bool mlsag_prepare(rct::key &a, rct::key &aG) = 0;
231  virtual bool mlsag_hash(const rct::keyV &long_message, rct::key &c) = 0;
232  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;
233 
234  virtual bool close_tx(void) = 0;
235  virtual bool get_transaction_prefix_hash(const cryptonote::transaction_prefix& tx, crypto::hash& tx_prefix_hash) = 0;
236  virtual bool generate_input_signature(const crypto::hash &prefix_hash, const uint32_t input_index, const crypto::secret_key sec_view, const crypto::secret_key sec_spend, crypto::signature& signature) = 0;
237  virtual bool generate_ring_signature(const crypto::hash &prefix_hash, const crypto::key_image &image,
238  const std::vector<const crypto::public_key *> &pubs,
239  const crypto::secret_key &sec, std::size_t sec_index,
240  crypto::signature *sig) = 0;
241 
242  virtual bool hash_to_scalar(boost::shared_ptr<crypto::rs_comm> buf, size_t length, crypto::ec_scalar &res) = 0;
243  virtual bool has_ki_cold_sync(void) const { return false; }
244  virtual bool has_tx_cold_sign(void) const { return false; }
245  virtual bool has_ki_live_refresh(void) const { return true; }
246  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) { return false; }
247  virtual void computing_key_images(bool started) {};
249 
250  protected:
252  } ;
253 
254  struct reset_mode {
256  reset_mode(hw::device& dev) : hwref(dev) { }
258  };
259 
261  private:
262  std::map<std::string, std::unique_ptr<device>> registry;
263 
264  public:
265  device_registry();
266  bool register_device(const std::string & device_name, device * hw_device);
267  device& get_device(const std::string & device_descriptor);
268  };
269 
270  device& get_device(const std::string & device_descriptor);
271  bool register_device(const std::string & device_name, device * hw_device);
272 }
273 
const char * res
Definition: hmac_keccak.cpp:41
virtual bool has_ki_cold_sync(void) const
Definition: device.hpp:243
virtual device_type get_type() const =0
virtual bool encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key)=0
virtual bool secret_key_to_public_key(const crypto::secret_key &sec, crypto::public_key &pub)=0
virtual device_protocol_t device_protocol() const
Definition: device.hpp:135
virtual bool scalarmultKey(rct::key &aP, const rct::key &P, const rct::key &a)=0
std::vector< std::string > keypair
virtual bool verify_keys(const crypto::secret_key &secret_key, const crypto::public_key &public_key)=0
virtual bool generate_chacha_key(const cryptonote::account_keys &keys, crypto::chacha_key &key, uint64_t kdf_rounds)=0
virtual bool sc_secret_add(crypto::secret_key &r, const crypto::secret_key &a, const crypto::secret_key &b)=0
virtual bool generate_input_signature(const crypto::hash &prefix_hash, const uint32_t input_index, const crypto::secret_key sec_view, const crypto::secret_key sec_spend, crypto::signature &signature)=0
virtual rct::key genCommitmentMask(const rct::key &amount_key)=0
::std::string string
Definition: gtest-port.h:1097
POD_CLASS key_derivation
Definition: crypto.h:98
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 indeterminate() const
Definition: device.hpp:74
virtual void on_progress(const device_progress &event)
Definition: device.hpp:83
virtual bool ecdhEncode(rct::ecdhTuple &unmasked, const rct::key &sharedSec, bool short_amount)=0
virtual bool set_mode(device_mode mode)
Definition: device.hpp:130
const char * key
Definition: hmac_keccak.cpp:39
epee::mlocked< tools::scrubbed< ec_scalar > > secret_key
Definition: crypto.h:82
bool register_device(const std::string &device_name, device *hw_device)
Definition: device.cpp:100
virtual void lock(void)=0
virtual device_mode get_mode() const
Definition: device.hpp:131
bool register_device(const std::string &device_name, device *hw_device)
Definition: device.cpp:66
device & get_device(const std::string &device_descriptor)
Definition: device.cpp:76
virtual void unlock(void)=0
struct hash_func hashes[]
virtual bool set_name(const std::string &name)=0
virtual bool has_ki_live_refresh(void) const
Definition: device.hpp:245
virtual bool disconnect(void)=0
virtual void on_button_pressed()
Definition: device.hpp:80
virtual bool generate_key_derivation(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation)=0
device & hwref
Definition: device.hpp:255
std::vector< key > keyV
Definition: rctTypes.h:88
Holds cryptonote related classes and helpers.
Definition: ban.cpp:40
device_mode mode
Definition: device.hpp:251
std::string name
Definition: device.hpp:89
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 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 crypto::secret_key get_subaddress_private_spendkey(const cryptonote::account_keys &keys, const cryptonote::subaddress_index &subaddr_index)=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
unsigned int uint32_t
Definition: stdint.h:126
device_protocol_t
Definition: device.hpp:112
POD_CLASS ec_scalar
Definition: crypto.h:74
virtual bool get_public_address(cryptonote::account_public_address &pubkey)=0
virtual void set_callback(i_device_callback *callback)
Definition: device.hpp:136
device & get_device(const std::string &device_descriptor)
Definition: device.cpp:95
std::vector< ctkey > ctkeyV
Definition: rctTypes.h:100
rct::key scalarmultKey(const rct::key &P, const rct::key &a)
Definition: device.hpp:185
unsigned __int64 uint64_t
Definition: stdint.h:136
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 void set_pin(const epee::wipeable_string &pin)
Definition: device.hpp:139
bool decrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key)
Definition: device.hpp:210
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)=0
virtual bool generate_key_image(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_image &image)=0
Definition: device.cpp:38
virtual bool open_tx(crypto::secret_key &tx_key)=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 cryptonote::account_public_address get_subaddress(const cryptonote::account_keys &keys, const cryptonote::subaddress_index &index)=0
virtual ~device()
Definition: device.hpp:95
virtual bool close_tx(void)=0
POD_CLASS public_key
Definition: crypto.h:76
const char * buf
Definition: slow_memmem.cpp:74
rct::key scalarmultBase(const rct::key &a)
Definition: device.hpp:192
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 mlsag_hash(const rct::keyV &long_message, rct::key &c)=0
const GenericPointer< typename T::ValueType > T2 T::AllocatorType & a
Definition: pointer.h:1124
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 double progress() const
Definition: device.hpp:73
virtual void set_passphrase(const epee::wipeable_string &passphrase)
Definition: device.hpp:140
POD_CLASS signature
Definition: crypto.h:108
POD_CLASS hash8
Definition: hash.h:53
virtual bool get_secret_keys(crypto::secret_key &viewkey, crypto::secret_key &spendkey)=0
virtual bool scalarmultBase(rct::key &aG, const rct::key &a)=0
POD_CLASS key_image
Definition: crypto.h:102
virtual bool derivation_to_scalar(const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res)=0
Matcher< T > A()
reset_mode(hw::device &dev)
Definition: device.hpp:256
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)
Definition: device.hpp:246
int bool
Definition: stdbool.h:36
virtual bool release()=0
virtual boost::optional< epee::wipeable_string > on_pin_request()
Definition: device.hpp:81
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 get_transaction_prefix_hash(const cryptonote::transaction_prefix &tx, crypto::hash &tx_prefix_hash)=0
virtual crypto::secret_key get_subaddress_secret_key(const crypto::secret_key &sec, const cryptonote::subaddress_index &index)=0
POD_CLASS hash
Definition: hash.h:50
const char * spendkey
Definition: multisig.cpp:38
virtual crypto::public_key get_subaddress_spend_public_key(const cryptonote::account_keys &keys, const cryptonote::subaddress_index &index)=0
virtual bool hash_to_scalar(boost::shared_ptr< crypto::rs_comm > buf, size_t length, crypto::ec_scalar &res)=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 connect(void)=0
virtual void set_derivation_path(const std::string &derivation_path)
Definition: device.hpp:137
virtual bool has_tx_cold_sign(void) const
Definition: device.hpp:244
device(const device &hwdev)
Definition: device.hpp:94
virtual bool generate_ring_signature(const crypto::hash &prefix_hash, const crypto::key_image &image, const std::vector< const crypto::public_key *> &pubs, const crypto::secret_key &sec, std::size_t sec_index, crypto::signature *sig)=0
virtual const std::string get_name() const =0
virtual ~i_device_callback()=default
virtual boost::optional< epee::wipeable_string > on_passphrase_request(bool on_device)
Definition: device.hpp:82
virtual void on_button_request(uint64_t code=0)
Definition: device.hpp:79
virtual crypto::secret_key get_subaddress_private_viewkey(const crypto::secret_key &main_wallet_sec_view, crypto::secret_key &subaddress_sec_spend)=0
virtual bool try_lock(void)=0
virtual bool init(void)=0
virtual void computing_key_images(bool started)
Definition: device.hpp:247
virtual void set_network_type(cryptonote::network_type network_type)
Definition: device.hpp:248
int rows
Definition: crypto.h:86
virtual bool ecdhDecode(rct::ecdhTuple &masked, const rct::key &sharedSec, bool short_amount)=0