Branch data Line data Source code
1 : : // Copyright (c) 2014-2021 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <key_io.h>
6 : :
7 : : #include <base58.h>
8 : : #include <bech32.h>
9 : : #include <script/interpreter.h>
10 : : #include <script/solver.h>
11 : : #include <tinyformat.h>
12 : : #include <util/strencodings.h>
13 : :
14 : : #include <algorithm>
15 : : #include <assert.h>
16 : : #include <string.h>
17 : :
18 : : /// Maximum witness length for Bech32 addresses.
19 : : static constexpr std::size_t BECH32_WITNESS_PROG_MAX_LEN = 40;
20 : :
21 : : namespace {
22 : : class DestinationEncoder
23 : : {
24 : : private:
25 : : const CChainParams& m_params;
26 : :
27 : : public:
28 : 96329 : explicit DestinationEncoder(const CChainParams& params) : m_params(params) {}
29 : :
30 : 31624 : std::string operator()(const PKHash& id) const
31 : : {
32 : 31624 : std::vector<unsigned char> data = m_params.Base58Prefix(CChainParams::PUBKEY_ADDRESS);
33 [ + - ]: 31624 : data.insert(data.end(), id.begin(), id.end());
34 [ + - ]: 31624 : return EncodeBase58Check(data);
35 : 31624 : }
36 : :
37 : 9370 : std::string operator()(const ScriptHash& id) const
38 : : {
39 : 9370 : std::vector<unsigned char> data = m_params.Base58Prefix(CChainParams::SCRIPT_ADDRESS);
40 [ + - ]: 9370 : data.insert(data.end(), id.begin(), id.end());
41 [ + - ]: 9370 : return EncodeBase58Check(data);
42 : 9370 : }
43 : :
44 : 35233 : std::string operator()(const WitnessV0KeyHash& id) const
45 : : {
46 : 35233 : std::vector<unsigned char> data = {0};
47 [ + - ]: 35233 : data.reserve(33);
48 [ + - ]: 1162689 : ConvertBits<8, 5, true>([&](unsigned char c) { data.push_back(c); }, id.begin(), id.end());
49 [ + - ]: 35233 : return bech32::Encode(bech32::Encoding::BECH32, m_params.Bech32HRP(), data);
50 : 35233 : }
51 : :
52 : 2990 : std::string operator()(const WitnessV0ScriptHash& id) const
53 : : {
54 : 2990 : std::vector<unsigned char> data = {0};
55 [ + - ]: 2990 : data.reserve(53);
56 [ + - ]: 158470 : ConvertBits<8, 5, true>([&](unsigned char c) { data.push_back(c); }, id.begin(), id.end());
57 [ + - ]: 2990 : return bech32::Encode(bech32::Encoding::BECH32, m_params.Bech32HRP(), data);
58 : 2990 : }
59 : :
60 : 17031 : std::string operator()(const WitnessV1Taproot& tap) const
61 : : {
62 : 17031 : std::vector<unsigned char> data = {1};
63 [ + - ]: 17031 : data.reserve(53);
64 [ + - ]: 902643 : ConvertBits<8, 5, true>([&](unsigned char c) { data.push_back(c); }, tap.begin(), tap.end());
65 [ + - ]: 17031 : return bech32::Encode(bech32::Encoding::BECH32M, m_params.Bech32HRP(), data);
66 : 17031 : }
67 : :
68 : 81 : std::string operator()(const WitnessUnknown& id) const
69 : : {
70 [ + - ]: 81 : const std::vector<unsigned char>& program = id.GetWitnessProgram();
71 [ + - + - : 81 : if (id.GetWitnessVersion() < 1 || id.GetWitnessVersion() > 16 || program.size() < 2 || program.size() > 40) {
+ - - + ]
72 : 0 : return {};
73 : : }
74 : 81 : std::vector<unsigned char> data = {(unsigned char)id.GetWitnessVersion()};
75 [ + - ]: 81 : data.reserve(1 + (program.size() * 8 + 4) / 5);
76 [ + - ]: 2314 : ConvertBits<8, 5, true>([&](unsigned char c) { data.push_back(c); }, program.begin(), program.end());
77 [ + - ]: 81 : return bech32::Encode(bech32::Encoding::BECH32M, m_params.Bech32HRP(), data);
78 : 81 : }
79 : :
80 : 0 : std::string operator()(const CNoDestination& no) const { return {}; }
81 : 0 : std::string operator()(const PubKeyDestination& pk) const { return {}; }
82 : : };
83 : :
84 : 22687 : CTxDestination DecodeDestination(const std::string& str, const CChainParams& params, std::string& error_str, std::vector<int>* error_locations)
85 : : {
86 : 22687 : std::vector<unsigned char> data;
87 : 22687 : uint160 hash;
88 [ + - ]: 22687 : error_str = "";
89 : :
90 : : // Note this will be false if it is a valid Bech32 address for a different network
91 [ + - + - ]: 22687 : bool is_bech32 = (ToLower(str.substr(0, params.Bech32HRP().size())) == params.Bech32HRP());
92 : :
93 [ + + + - : 22687 : if (!is_bech32 && DecodeBase58Check(str, data, 21)) {
+ + ]
94 : : // base58-encoded Bitcoin addresses.
95 : : // Public-key-hash-addresses have version 0 (or 111 testnet).
96 : : // The data vector contains RIPEMD160(SHA256(pubkey)), where pubkey is the serialized public key.
97 [ + - ]: 9019 : const std::vector<unsigned char>& pubkey_prefix = params.Base58Prefix(CChainParams::PUBKEY_ADDRESS);
98 [ + - + + ]: 9019 : if (data.size() == hash.size() + pubkey_prefix.size() && std::equal(pubkey_prefix.begin(), pubkey_prefix.end(), data.begin())) {
99 : 7765 : std::copy(data.begin() + pubkey_prefix.size(), data.end(), hash.begin());
100 : 7765 : return PKHash(hash);
101 : : }
102 : : // Script-hash-addresses have version 5 (or 196 testnet).
103 : : // The data vector contains RIPEMD160(SHA256(cscript)), where cscript is the serialized redemption script.
104 [ + - ]: 1254 : const std::vector<unsigned char>& script_prefix = params.Base58Prefix(CChainParams::SCRIPT_ADDRESS);
105 [ + - + + ]: 1254 : if (data.size() == hash.size() + script_prefix.size() && std::equal(script_prefix.begin(), script_prefix.end(), data.begin())) {
106 : 1237 : std::copy(data.begin() + script_prefix.size(), data.end(), hash.begin());
107 : 1237 : return ScriptHash(hash);
108 : : }
109 : :
110 : : // If the prefix of data matches either the script or pubkey prefix, the length must have been wrong
111 [ + - ]: 17 : if ((data.size() >= script_prefix.size() &&
112 [ + - + - ]: 17 : std::equal(script_prefix.begin(), script_prefix.end(), data.begin())) ||
113 [ + - - + ]: 17 : (data.size() >= pubkey_prefix.size() &&
114 [ - + ]: 17 : std::equal(pubkey_prefix.begin(), pubkey_prefix.end(), data.begin()))) {
115 [ # # ]: 0 : error_str = "Invalid length for Base58 address (P2PKH or P2SH)";
116 : : } else {
117 [ + - ]: 17 : error_str = "Invalid or unsupported Base58-encoded address.";
118 : : }
119 : 17 : return CNoDestination();
120 [ + + ]: 13668 : } else if (!is_bech32) {
121 : : // Try Base58 decoding without the checksum, using a much larger max length
122 [ + - + + ]: 272 : if (!DecodeBase58(str, data, 100)) {
123 [ + - ]: 128 : error_str = "Invalid or unsupported Segwit (Bech32) or Base58 encoding.";
124 : : } else {
125 [ + - ]: 144 : error_str = "Invalid checksum or length of Base58 address (P2PKH or P2SH)";
126 : : }
127 : 272 : return CNoDestination();
128 : : }
129 : :
130 [ - + ]: 13396 : data.clear();
131 [ + - ]: 13396 : const auto dec = bech32::Decode(str);
132 [ + + ]: 13396 : if (dec.encoding == bech32::Encoding::BECH32 || dec.encoding == bech32::Encoding::BECH32M) {
133 [ + + ]: 13375 : if (dec.data.empty()) {
134 [ + - ]: 5 : error_str = "Empty Bech32 data section";
135 : 5 : return CNoDestination();
136 : : }
137 : : // Bech32 decoding
138 [ + + ]: 13370 : if (dec.hrp != params.Bech32HRP()) {
139 [ + - ]: 10 : error_str = strprintf("Invalid or unsupported prefix for Segwit (Bech32) address (expected %s, got %s).", params.Bech32HRP(), dec.hrp);
140 : 10 : return CNoDestination();
141 : : }
142 [ + + ]: 13360 : int version = dec.data[0]; // The first 5 bit symbol is the witness version (0-16)
143 [ + + + + ]: 13360 : if (version == 0 && dec.encoding != bech32::Encoding::BECH32) {
144 [ + - ]: 8 : error_str = "Version 0 witness address must use Bech32 checksum";
145 : 8 : return CNoDestination();
146 : : }
147 [ + + ]: 610 : if (version != 0 && dec.encoding != bech32::Encoding::BECH32M) {
148 [ + - ]: 15 : error_str = "Version 1+ witness address must use Bech32m checksum";
149 : 15 : return CNoDestination();
150 : : }
151 : : // The rest of the symbols are converted witness program bytes.
152 [ + - ]: 13337 : data.reserve(((dec.data.size() - 1) * 5) / 8);
153 [ + - + + ]: 289345 : if (ConvertBits<5, 8, false>([&](unsigned char c) { data.push_back(c); }, dec.data.begin() + 1, dec.data.end())) {
154 : :
155 [ + + ]: 13331 : std::string_view byte_str{data.size() == 1 ? "byte" : "bytes"};
156 : :
157 [ + + ]: 13331 : if (version == 0) {
158 : 12737 : {
159 [ + + ]: 12737 : WitnessV0KeyHash keyid;
160 [ + + ]: 12737 : if (data.size() == keyid.size()) {
161 : 12511 : std::copy(data.begin(), data.end(), keyid.begin());
162 : 12511 : return keyid;
163 : : }
164 : : }
165 : 226 : {
166 [ + + ]: 226 : WitnessV0ScriptHash scriptid;
167 [ + + ]: 226 : if (data.size() == scriptid.size()) {
168 : 217 : std::copy(data.begin(), data.end(), scriptid.begin());
169 : 217 : return scriptid;
170 : : }
171 : : }
172 : :
173 [ + - ]: 9 : error_str = strprintf("Invalid Bech32 v0 address program size (%d %s), per BIP141", data.size(), byte_str);
174 : 9 : return CNoDestination();
175 : : }
176 : :
177 [ + + + + ]: 594 : if (version == 1 && data.size() == WITNESS_V1_TAPROOT_SIZE) {
178 : 546 : static_assert(WITNESS_V1_TAPROOT_SIZE == WitnessV1Taproot::size());
179 : 546 : WitnessV1Taproot tap;
180 : 546 : std::copy(data.begin(), data.end(), tap.begin());
181 : 546 : return tap;
182 : : }
183 : :
184 [ + - + + ]: 48 : if (CScript::IsPayToAnchor(version, data)) {
185 [ + - ]: 1 : return PayToAnchor();
186 : : }
187 : :
188 [ + + ]: 47 : if (version > 16) {
189 [ + - ]: 8 : error_str = "Invalid Bech32 address witness version";
190 : 8 : return CNoDestination();
191 : : }
192 : :
193 [ + + + + ]: 39 : if (data.size() < 2 || data.size() > BECH32_WITNESS_PROG_MAX_LEN) {
194 [ + - ]: 12 : error_str = strprintf("Invalid Bech32 address program size (%d %s)", data.size(), byte_str);
195 : 12 : return CNoDestination();
196 : : }
197 : :
198 [ + - ]: 27 : return WitnessUnknown{version, data};
199 : : } else {
200 [ + - ]: 6 : error_str = strprintf("Invalid padding in Bech32 data section");
201 : 6 : return CNoDestination();
202 : : }
203 : : }
204 : :
205 : : // Perform Bech32 error location
206 [ + - ]: 21 : auto res = bech32::LocateErrors(str);
207 [ + - ]: 21 : error_str = res.first;
208 [ + + ]: 21 : if (error_locations) *error_locations = std::move(res.second);
209 : 21 : return CNoDestination();
210 : 36104 : }
211 : : } // namespace
212 : :
213 : 1744 : CKey DecodeSecret(const std::string& str)
214 : : {
215 : 1744 : CKey key;
216 : 1744 : std::vector<unsigned char> data;
217 [ + - + + ]: 1744 : if (DecodeBase58Check(str, data, 34)) {
218 [ + - + + ]: 1360 : const std::vector<unsigned char>& privkey_prefix = Params().Base58Prefix(CChainParams::SECRET_KEY);
219 [ + + + + : 1360 : if ((data.size() == 32 + privkey_prefix.size() || (data.size() == 33 + privkey_prefix.size() && data.back() == 1)) &&
+ + + + ]
220 [ + + ]: 1335 : std::equal(privkey_prefix.begin(), privkey_prefix.end(), data.begin())) {
221 : 1319 : bool compressed = data.size() == 33 + privkey_prefix.size();
222 [ + - ]: 1319 : key.Set(data.begin() + privkey_prefix.size(), data.begin() + privkey_prefix.size() + 32, compressed);
223 : : }
224 : : }
225 [ + + ]: 1744 : if (!data.empty()) {
226 [ + - ]: 1360 : memory_cleanse(data.data(), data.size());
227 : : }
228 : 1744 : return key;
229 : 1744 : }
230 : :
231 : 226 : std::string EncodeSecret(const CKey& key)
232 : : {
233 [ - + ]: 226 : assert(key.IsValid());
234 : 226 : std::vector<unsigned char> data = Params().Base58Prefix(CChainParams::SECRET_KEY);
235 [ + - + - : 678 : data.insert(data.end(), UCharCast(key.begin()), UCharCast(key.end()));
+ - ]
236 [ + + ]: 226 : if (key.IsCompressed()) {
237 [ + - ]: 200 : data.push_back(1);
238 : : }
239 [ + - ]: 226 : std::string ret = EncodeBase58Check(data);
240 [ + - ]: 226 : memory_cleanse(data.data(), data.size());
241 : 226 : return ret;
242 : 226 : }
243 : :
244 : 6049 : CExtPubKey DecodeExtPubKey(const std::string& str)
245 : : {
246 [ + - ]: 6049 : CExtPubKey key;
247 : 6049 : std::vector<unsigned char> data;
248 [ + - + + ]: 6049 : if (DecodeBase58Check(str, data, 78)) {
249 [ + - + - ]: 6045 : const std::vector<unsigned char>& prefix = Params().Base58Prefix(CChainParams::EXT_PUBLIC_KEY);
250 [ + - + + ]: 6045 : if (data.size() == BIP32_EXTKEY_SIZE + prefix.size() && std::equal(prefix.begin(), prefix.end(), data.begin())) {
251 [ + - ]: 5406 : key.Decode(data.data() + prefix.size());
252 : : }
253 : : }
254 : 6049 : return key;
255 : 6049 : }
256 : :
257 : 124450 : std::string EncodeExtPubKey(const CExtPubKey& key)
258 : : {
259 : 124450 : std::vector<unsigned char> data = Params().Base58Prefix(CChainParams::EXT_PUBLIC_KEY);
260 [ + - ]: 124450 : size_t size = data.size();
261 [ + - ]: 124450 : data.resize(size + BIP32_EXTKEY_SIZE);
262 [ + - ]: 124450 : key.Encode(data.data() + size);
263 [ + - ]: 124450 : std::string ret = EncodeBase58Check(data);
264 : 124450 : return ret;
265 : 124450 : }
266 : :
267 : 6045 : CExtKey DecodeExtKey(const std::string& str)
268 : : {
269 [ + - ]: 6045 : CExtKey key;
270 : 6045 : std::vector<unsigned char> data;
271 [ + - + + ]: 6045 : if (DecodeBase58Check(str, data, 78)) {
272 [ + - + - ]: 6041 : const std::vector<unsigned char>& prefix = Params().Base58Prefix(CChainParams::EXT_SECRET_KEY);
273 [ + - + + ]: 6041 : if (data.size() == BIP32_EXTKEY_SIZE + prefix.size() && std::equal(prefix.begin(), prefix.end(), data.begin())) {
274 [ + - ]: 654 : key.Decode(data.data() + prefix.size());
275 : : }
276 : : }
277 [ + + ]: 6045 : if (!data.empty()) {
278 [ + - ]: 6041 : memory_cleanse(data.data(), data.size());
279 : : }
280 : 6045 : return key;
281 : 6045 : }
282 : :
283 : 305 : std::string EncodeExtKey(const CExtKey& key)
284 : : {
285 : 305 : std::vector<unsigned char> data = Params().Base58Prefix(CChainParams::EXT_SECRET_KEY);
286 [ + - ]: 305 : size_t size = data.size();
287 [ + - ]: 305 : data.resize(size + BIP32_EXTKEY_SIZE);
288 [ + - ]: 305 : key.Encode(data.data() + size);
289 [ + - ]: 305 : std::string ret = EncodeBase58Check(data);
290 [ + - ]: 305 : memory_cleanse(data.data(), data.size());
291 : 305 : return ret;
292 : 305 : }
293 : :
294 : 96329 : std::string EncodeDestination(const CTxDestination& dest)
295 : : {
296 : 96329 : return std::visit(DestinationEncoder(Params()), dest);
297 : : }
298 : :
299 : 22677 : CTxDestination DecodeDestination(const std::string& str, std::string& error_msg, std::vector<int>* error_locations)
300 : : {
301 : 22677 : return DecodeDestination(str, Params(), error_msg, error_locations);
302 : : }
303 : :
304 : 21863 : CTxDestination DecodeDestination(const std::string& str)
305 : : {
306 [ + - ]: 21863 : std::string error_msg;
307 [ + - ]: 21863 : return DecodeDestination(str, error_msg);
308 : 21863 : }
309 : :
310 : 10 : bool IsValidDestinationString(const std::string& str, const CChainParams& params)
311 : : {
312 [ + - ]: 10 : std::string error_msg;
313 [ + - + - ]: 10 : return IsValidDestination(DecodeDestination(str, params, error_msg, nullptr));
314 : 10 : }
315 : :
316 : 10 : bool IsValidDestinationString(const std::string& str)
317 : : {
318 : 10 : return IsValidDestinationString(str, Params());
319 : : }
|
