Electroneum
device_default.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 "device.hpp"
33 
34 namespace hw {
35 
36  namespace core {
37 
38  void register_all(std::map<std::string, std::unique_ptr<device>> &registry);
39 
40  class device_default : public hw::device {
41  public:
44 
45  device_default(const device_default &device) = delete;
47 
48  explicit operator bool() const override { return false; };
49 
50  /* ======================================================================= */
51  /* SETUP/TEARDOWN */
52  /* ======================================================================= */
53  bool set_name(const std::string &name) override;
54  const std::string get_name() const override;
55 
56  bool init(void) override;
57  bool release() override;
58 
59  bool connect(void) override;
60  bool disconnect() override;
61 
62  bool set_mode(device_mode mode) override;
63 
64  device_type get_type() const override {return device_type::SOFTWARE;};
65 
66  /* ======================================================================= */
67  /* LOCKER */
68  /* ======================================================================= */
69  void lock(void) override;
70  void unlock(void) override;
71  bool try_lock(void) override;
72 
73  /* ======================================================================= */
74  /* WALLET & ADDRESS */
75  /* ======================================================================= */
78  bool generate_chacha_key(const cryptonote::account_keys &keys, crypto::chacha_key &key, uint64_t kdf_rounds) override;
79 
80  /* ======================================================================= */
81  /* SUB ADDRESS */
82  /* ======================================================================= */
83  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) override;
85  std::vector<crypto::public_key> get_subaddress_spend_public_keys(const cryptonote::account_keys &keys, uint32_t account, uint32_t begin, uint32_t end) override;
89  crypto::secret_key get_subaddress_private_viewkey(const crypto::secret_key &main_wallet_sec_view, crypto::secret_key &subaddress_sec_spend) override;
90 
91  /* ======================================================================= */
92  /* DERIVATION & KEY */
93  /* ======================================================================= */
95  bool scalarmultKey(rct::key & aP, const rct::key &P, const rct::key &a) override;
96  bool scalarmultBase(rct::key &aG, const rct::key &a) override;
97  bool sc_secret_add(crypto::secret_key &r, const crypto::secret_key &a, const crypto::secret_key &b) override;
98  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) override;
99  bool generate_key_derivation(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation) override;
100  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) override;
101  bool derivation_to_scalar(const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res) override;
102  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) override;
103  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) override;
104  bool secret_key_to_public_key(const crypto::secret_key &sec, crypto::public_key &pub) override;
105  bool generate_key_image(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_image &image) override;
106 
107 
108  /* ======================================================================= */
109  /* TRANSACTION */
110  /* ======================================================================= */
111 
112  void generate_tx_proof(const crypto::hash &prefix_hash,
113  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,
114  crypto::signature &sig) override;
115 
116  bool open_tx(crypto::secret_key &tx_key) override;
117 
119 
120  rct::key genCommitmentMask(const rct::key &amount_key) override;
121 
122  bool ecdhEncode(rct::ecdhTuple & unmasked, const rct::key & sharedSec, bool short_amount) override;
123  bool ecdhDecode(rct::ecdhTuple & masked, const rct::key & sharedSec, bool short_amount) override;
124 
125  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,
126  const cryptonote::tx_destination_entry &dst_entr, const boost::optional<cryptonote::account_public_address> &change_addr, const size_t output_index,
127  const bool &need_additional_txkeys, const std::vector<crypto::secret_key> &additional_tx_keys,
128  std::vector<crypto::public_key> &additional_tx_public_keys,
129  std::vector<rct::key> &amount_keys,
130  crypto::public_key &out_eph_public_key) override;
131 
132  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) override;
133  bool mlsag_prepare(const rct::key &H, const rct::key &xx, rct::key &a, rct::key &aG, rct::key &aHP, rct::key &rvII) override;
134  bool mlsag_prepare(rct::key &a, rct::key &aG) override;
135  bool mlsag_hash(const rct::keyV &long_message, rct::key &c) override;
136  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) override;
137 
138  bool close_tx(void) override;
139  bool get_transaction_prefix_hash(const cryptonote::transaction_prefix& tx, crypto::hash& tx_prefix_hash) override;
140  bool generate_ring_signature(const crypto::hash &prefix_hash, const crypto::key_image &image,
141  const std::vector<const crypto::public_key *> &pubs,
142  const crypto::secret_key &sec, std::size_t sec_index,
143  crypto::signature *sig) override;
144  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) override;
145  bool hash_to_scalar(boost::shared_ptr<crypto::rs_comm> buf, size_t length, crypto::ec_scalar &res) override;
146  };
147 
148  }
149 
150 
151 
152 }
153 
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) override
const char * res
Definition: hmac_keccak.cpp:41
bool encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) override
bool mlsag_hash(const rct::keyV &long_message, rct::key &c) override
cryptonote::account_public_address get_subaddress(const cryptonote::account_keys &keys, const cryptonote::subaddress_index &index) override
bool generate_key_image(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_image &image) override
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) override
::std::string string
Definition: gtest-port.h:1097
bool sc_secret_add(crypto::secret_key &r, const crypto::secret_key &a, const crypto::secret_key &b) override
POD_CLASS key_derivation
Definition: crypto.h:98
bool scalarmultBase(rct::key &aG, const rct::key &a) override
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) override
bool ecdhEncode(rct::ecdhTuple &unmasked, const rct::key &sharedSec, bool short_amount) override
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) override
const char * key
Definition: hmac_keccak.cpp:39
epee::mlocked< tools::scrubbed< ec_scalar > > secret_key
Definition: crypto.h:82
bool close_tx(void) override
void unlock(void) override
bool derivation_to_scalar(const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res) override
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) override
bool scalarmultKey(rct::key &aP, const rct::key &P, const rct::key &a) override
const std::string get_name() const override
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) override
struct hash_func hashes[]
crypto::secret_key get_subaddress_private_viewkey(const crypto::secret_key &main_wallet_sec_view, crypto::secret_key &subaddress_sec_spend) override
bool connect(void) override
bool open_tx(crypto::secret_key &tx_key) override
std::vector< key > keyV
Definition: rctTypes.h:88
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) override
device_mode mode
Definition: device.hpp:251
bool ecdhDecode(rct::ecdhTuple &masked, const rct::key &sharedSec, bool short_amount) override
void register_all(std::map< std::string, std::unique_ptr< device >> &registry)
std::string name
Definition: device.hpp:89
bool init(void) override
unsigned int uint32_t
Definition: stdint.h:126
POD_CLASS ec_scalar
Definition: crypto.h:74
std::vector< ctkey > ctkeyV
Definition: rctTypes.h:100
void lock(void) override
unsigned __int64 uint64_t
Definition: stdint.h:136
bool try_lock(void) override
Definition: device.cpp:38
bool verify_keys(const crypto::secret_key &secret_key, const crypto::public_key &public_key) override
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) override
POD_CLASS public_key
Definition: crypto.h:76
const char * buf
Definition: slow_memmem.cpp:74
bool disconnect() override
bool mlsag_prepare(const rct::key &H, const rct::key &xx, rct::key &a, rct::key &aG, rct::key &aHP, rct::key &rvII) override
const GenericPointer< typename T::ValueType > T2 T::AllocatorType & a
Definition: pointer.h:1124
bool hash_to_scalar(boost::shared_ptr< crypto::rs_comm > buf, size_t length, crypto::ec_scalar &res) override
crypto::secret_key get_subaddress_private_spendkey(const cryptonote::account_keys &keys, const cryptonote::subaddress_index &subaddr_index) override
bool secret_key_to_public_key(const crypto::secret_key &sec, crypto::public_key &pub) override
POD_CLASS signature
Definition: crypto.h:108
POD_CLASS hash8
Definition: hash.h:53
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) override
POD_CLASS key_image
Definition: crypto.h:102
device_default & operator=(const device_default &device)=delete
device_type get_type() const override
crypto::secret_key get_subaddress_secret_key(const crypto::secret_key &sec, const cryptonote::subaddress_index &index) override
Matcher< T > A()
bool get_transaction_prefix_hash(const cryptonote::transaction_prefix &tx, crypto::hash &tx_prefix_hash) override
int bool
Definition: stdbool.h:36
bool get_secret_keys(crypto::secret_key &viewkey, crypto::secret_key &spendkey) override
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) override
rct::key genCommitmentMask(const rct::key &amount_key) override
POD_CLASS hash
Definition: hash.h:50
crypto::public_key get_subaddress_spend_public_key(const cryptonote::account_keys &keys, const cryptonote::subaddress_index &index) override
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) override
const char * spendkey
Definition: multisig.cpp:38
bool set_name(const std::string &name) override
std::vector< crypto::public_key > get_subaddress_spend_public_keys(const cryptonote::account_keys &keys, uint32_t account, uint32_t begin, uint32_t end) override
bool generate_key_derivation(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation) override
bool generate_chacha_key(const cryptonote::account_keys &keys, crypto::chacha_key &key, uint64_t kdf_rounds) override
bool get_public_address(cryptonote::account_public_address &pubkey) override
bool set_mode(device_mode mode) override
int rows
Definition: crypto.h:86