1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
// Copyright (c) 2017-2023, The Monero Project
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
// of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#ifndef MONERO_DEVICE_COLD_H
#define MONERO_DEVICE_COLD_H
#include "wallet/wallet2.h"
#include <boost/optional/optional.hpp>
#include <boost/function.hpp>
namespace hw {
typedef struct wallet_shim {
boost::function<crypto::public_key (const tools::wallet2::transfer_details &td)> get_tx_pub_key_from_received_outs;
} wallet_shim;
class tx_aux_data {
public:
std::vector<std::string> tx_device_aux; // device generated aux data
std::vector<cryptonote::address_parse_info> tx_recipients; // as entered by user
boost::optional<int> bp_version; // BP version to use
boost::optional<unsigned> client_version; // Signing client version to use (testing)
boost::optional<uint8_t> hard_fork; // hard fork being used for the transaction
};
class device_cold {
public:
using exported_key_image = std::vector<std::pair<crypto::key_image, crypto::signature>>;
class op_progress : public hw::device_progress {
public:
op_progress():m_progress(0), m_indeterminate(false) {};
explicit op_progress(double progress, bool indeterminate=false): m_progress(progress), m_indeterminate(indeterminate){}
double progress() const override { return m_progress; }
bool indeterminate() const override { return m_indeterminate; }
protected:
double m_progress;
bool m_indeterminate;
};
class tx_progress : public op_progress {
public:
tx_progress():
m_cur_tx(0), m_max_tx(1),
m_cur_step(0), m_max_step(1),
m_cur_substep(0), m_max_substep(1){};
tx_progress(size_t cur_tx, size_t max_tx, size_t cur_step, size_t max_step, size_t cur_substep, size_t max_substep):
m_cur_tx(cur_tx), m_max_tx(max_tx),
m_cur_step(cur_tx), m_max_step(max_tx),
m_cur_substep(cur_tx), m_max_substep(max_tx){}
double progress() const override {
return std::max(1.0, (double)m_cur_tx / m_max_tx
+ (double)m_cur_step / (m_max_tx * m_max_step)
+ (double)m_cur_substep / (m_max_tx * m_max_step * m_max_substep));
}
bool indeterminate() const override { return false; }
protected:
size_t m_cur_tx;
size_t m_max_tx;
size_t m_cur_step;
size_t m_max_step;
size_t m_cur_substep;
size_t m_max_substep;
};
typedef struct {
std::string salt1;
std::string salt2;
std::string tx_enc_keys;
std::string tx_prefix_hash;
} tx_key_data_t;
/**
* Key image sync with the cold protocol.
*/
virtual void ki_sync(wallet_shim * wallet,
const std::vector<::tools::wallet2::transfer_details> & transfers,
exported_key_image & ski) =0;
/**
* Signs unsigned transaction with the cold protocol.
*/
virtual void tx_sign(wallet_shim * wallet,
const ::tools::wallet2::unsigned_tx_set & unsigned_tx,
::tools::wallet2::signed_tx_set & signed_tx,
tx_aux_data & aux_data) =0;
/**
* Get tx key support check.
*/
virtual bool is_get_tx_key_supported() const { return false; }
/**
* Loads TX aux data required for tx key.
*/
virtual void load_tx_key_data(tx_key_data_t & res, const std::string & tx_aux_data) =0;
/**
* Decrypts TX keys.
*/
virtual void get_tx_key(
std::vector<::crypto::secret_key> & tx_keys,
const tx_key_data_t & tx_aux_data,
const ::crypto::secret_key & view_key_priv) =0;
/**
* Live refresh support check
*/
virtual bool is_live_refresh_supported() const { return false; };
/**
* Starts live refresh process with the device
*/
virtual void live_refresh_start() =0;
/**
* One live refresh step
*/
virtual void live_refresh(
const ::crypto::secret_key & view_key_priv,
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
) =0;
/**
* Live refresh process termination
*/
virtual void live_refresh_finish() =0;
/**
* Requests public address, uses empty passphrase if asked for.
*/
virtual bool get_public_address_with_no_passphrase(cryptonote::account_public_address &pubkey) =0;
/**
* Reset session ID, restart with a new session.
*/
virtual void reset_session() =0;
/**
* Returns true if device already asked for passphrase entry before (i.e., obviously supports passphrase entry)
*/
virtual bool seen_passphrase_entry_prompt() =0;
/**
* Uses empty passphrase for all passphrase queries.
*/
virtual void set_use_empty_passphrase(bool always_use_empty_passphrase) =0;
};
}
#endif //MONERO_DEVICE_COLD_H
|
