Branch data Line data Source code
1 : : // Copyright (c) 2009-2022 The Bitcoin Core developers
2 : : // Copyright (c) 2017 The Zcash developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <pubkey.h>
7 : :
8 : : #include <hash.h>
9 : : #include <secp256k1.h>
10 : : #include <secp256k1_ellswift.h>
11 : : #include <secp256k1_extrakeys.h>
12 : : #include <secp256k1_recovery.h>
13 : : #include <secp256k1_schnorrsig.h>
14 : : #include <span.h>
15 : : #include <uint256.h>
16 : : #include <util/strencodings.h>
17 : :
18 : : #include <algorithm>
19 : : #include <cassert>
20 : :
21 : : using namespace util::hex_literals;
22 : :
23 : : namespace {
24 : :
25 : : struct Secp256k1SelfTester
26 : : {
27 : : Secp256k1SelfTester() {
28 : : /* Run libsecp256k1 self-test before using the secp256k1_context_static. */
29 : : secp256k1_selftest();
30 : : }
31 : : } SECP256K1_SELFTESTER;
32 : :
33 : : } // namespace
34 : :
35 : : /** This function is taken from the libsecp256k1 distribution and implements
36 : : * DER parsing for ECDSA signatures, while supporting an arbitrary subset of
37 : : * format violations.
38 : : *
39 : : * Supported violations include negative integers, excessive padding, garbage
40 : : * at the end, and overly long length descriptors. This is safe to use in
41 : : * Bitcoin because since the activation of BIP66, signatures are verified to be
42 : : * strict DER before being passed to this module, and we know it supports all
43 : : * violations present in the blockchain before that point.
44 : : */
45 : 47433 : int ecdsa_signature_parse_der_lax(secp256k1_ecdsa_signature* sig, const unsigned char *input, size_t inputlen) {
46 : 47433 : size_t rpos, rlen, spos, slen;
47 : 47433 : size_t pos = 0;
48 : 47433 : size_t lenbyte;
49 : 47433 : unsigned char tmpsig[64] = {0};
50 : 47433 : int overflow = 0;
51 : :
52 : : /* Hack to initialize sig with a correctly-parsed but invalid signature. */
53 : 47433 : secp256k1_ecdsa_signature_parse_compact(secp256k1_context_static, sig, tmpsig);
54 : :
55 : : /* Sequence tag byte */
56 [ + + + - ]: 47433 : if (pos == inputlen || input[pos] != 0x30) {
57 : : return 0;
58 : : }
59 : 47397 : pos++;
60 : :
61 : : /* Sequence length bytes */
62 [ + - ]: 47397 : if (pos == inputlen) {
63 : : return 0;
64 : : }
65 : 47397 : lenbyte = input[pos++];
66 [ - + ]: 47397 : if (lenbyte & 0x80) {
67 : 0 : lenbyte -= 0x80;
68 [ # # ]: 0 : if (lenbyte > inputlen - pos) {
69 : : return 0;
70 : : }
71 : 0 : pos += lenbyte;
72 : : }
73 : :
74 : : /* Integer tag byte for R */
75 [ + - + - ]: 47397 : if (pos == inputlen || input[pos] != 0x02) {
76 : : return 0;
77 : : }
78 : 47397 : pos++;
79 : :
80 : : /* Integer length for R */
81 [ + - ]: 47397 : if (pos == inputlen) {
82 : : return 0;
83 : : }
84 : 47397 : lenbyte = input[pos++];
85 [ - + ]: 47397 : if (lenbyte & 0x80) {
86 : 0 : lenbyte -= 0x80;
87 [ # # ]: 0 : if (lenbyte > inputlen - pos) {
88 : : return 0;
89 : : }
90 [ # # # # ]: 0 : while (lenbyte > 0 && input[pos] == 0) {
91 : 0 : pos++;
92 : 0 : lenbyte--;
93 : : }
94 : 0 : static_assert(sizeof(size_t) >= 4, "size_t too small");
95 [ # # ]: 0 : if (lenbyte >= 4) {
96 : : return 0;
97 : : }
98 : : rlen = 0;
99 [ # # ]: 0 : while (lenbyte > 0) {
100 : 0 : rlen = (rlen << 8) + input[pos];
101 : 0 : pos++;
102 : 0 : lenbyte--;
103 : : }
104 : : } else {
105 : : rlen = lenbyte;
106 : : }
107 [ + - ]: 47397 : if (rlen > inputlen - pos) {
108 : : return 0;
109 : : }
110 : 47397 : rpos = pos;
111 : 47397 : pos += rlen;
112 : :
113 : : /* Integer tag byte for S */
114 [ + - + - ]: 47397 : if (pos == inputlen || input[pos] != 0x02) {
115 : : return 0;
116 : : }
117 : 47397 : pos++;
118 : :
119 : : /* Integer length for S */
120 [ + - ]: 47397 : if (pos == inputlen) {
121 : : return 0;
122 : : }
123 : 47397 : lenbyte = input[pos++];
124 [ - + ]: 47397 : if (lenbyte & 0x80) {
125 : 0 : lenbyte -= 0x80;
126 [ # # ]: 0 : if (lenbyte > inputlen - pos) {
127 : : return 0;
128 : : }
129 [ # # # # ]: 0 : while (lenbyte > 0 && input[pos] == 0) {
130 : 0 : pos++;
131 : 0 : lenbyte--;
132 : : }
133 : 0 : static_assert(sizeof(size_t) >= 4, "size_t too small");
134 [ # # ]: 0 : if (lenbyte >= 4) {
135 : : return 0;
136 : : }
137 : : slen = 0;
138 [ # # ]: 0 : while (lenbyte > 0) {
139 : 0 : slen = (slen << 8) + input[pos];
140 : 0 : pos++;
141 : 0 : lenbyte--;
142 : : }
143 : : } else {
144 : : slen = lenbyte;
145 : : }
146 [ + - ]: 47397 : if (slen > inputlen - pos) {
147 : : return 0;
148 : : }
149 : 50512 : spos = pos;
150 : :
151 : : /* Ignore leading zeroes in R */
152 [ + - + + ]: 50512 : while (rlen > 0 && input[rpos] == 0) {
153 : 3115 : rlen--;
154 : 3115 : rpos++;
155 : : }
156 : : /* Copy R value */
157 [ + + ]: 47397 : if (rlen > 32) {
158 : 47397 : overflow = 1;
159 : : } else {
160 : 47396 : memcpy(tmpsig + 32 - rlen, input + rpos, rlen);
161 : : }
162 : :
163 : : /* Ignore leading zeroes in S */
164 [ + - + + ]: 48953 : while (slen > 0 && input[spos] == 0) {
165 : 1556 : slen--;
166 : 1556 : spos++;
167 : : }
168 : : /* Copy S value */
169 [ + - ]: 47397 : if (slen > 32) {
170 : : overflow = 1;
171 : : } else {
172 [ + + ]: 47397 : memcpy(tmpsig + 64 - slen, input + spos, slen);
173 : : }
174 : :
175 [ + + ]: 47397 : if (!overflow) {
176 : 47396 : overflow = !secp256k1_ecdsa_signature_parse_compact(secp256k1_context_static, sig, tmpsig);
177 : : }
178 [ - + ]: 47396 : if (overflow) {
179 : : /* Overwrite the result again with a correctly-parsed but invalid
180 : : signature if parsing failed. */
181 : 1 : memset(tmpsig, 0, 64);
182 : 1 : secp256k1_ecdsa_signature_parse_compact(secp256k1_context_static, sig, tmpsig);
183 : : }
184 : : return 1;
185 : : }
186 : :
187 : : /** Nothing Up My Sleeve (NUMS) point
188 : : *
189 : : * NUMS_H is a point with an unknown discrete logarithm, constructed by taking the sha256 of 'g'
190 : : * (uncompressed encoding), which happens to be a point on the curve.
191 : : *
192 : : * For an example script for calculating H, refer to the unit tests in
193 : : * ./test/functional/test_framework/crypto/secp256k1.py
194 : : */
195 : : constexpr XOnlyPubKey XOnlyPubKey::NUMS_H{"50929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac0"_hex_u8};
196 : :
197 : 821 : std::vector<CKeyID> XOnlyPubKey::GetKeyIDs() const
198 : : {
199 : 821 : std::vector<CKeyID> out;
200 : : // For now, use the old full pubkey-based key derivation logic. As it is indexed by
201 : : // Hash160(full pubkey), we need to return both a version prefixed with 0x02, and one
202 : : // with 0x03.
203 : 821 : unsigned char b[33] = {0x02};
204 : 821 : std::copy(m_keydata.begin(), m_keydata.end(), b + 1);
205 : 821 : CPubKey fullpubkey;
206 : 821 : fullpubkey.Set(b, b + 33);
207 [ + - ]: 821 : out.push_back(fullpubkey.GetID());
208 : 821 : b[0] = 0x03;
209 : 821 : fullpubkey.Set(b, b + 33);
210 [ + - ]: 821 : out.push_back(fullpubkey.GetID());
211 : 821 : return out;
212 : 0 : }
213 : :
214 : 1061 : CPubKey XOnlyPubKey::GetEvenCorrespondingCPubKey() const
215 : : {
216 : 1061 : unsigned char full_key[CPubKey::COMPRESSED_SIZE] = {0x02};
217 : 1061 : std::copy(begin(), end(), full_key + 1);
218 : 1061 : return CPubKey{full_key};
219 : : }
220 : :
221 : 76511 : bool XOnlyPubKey::IsFullyValid() const
222 : : {
223 : 76511 : secp256k1_xonly_pubkey pubkey;
224 : 76511 : return secp256k1_xonly_pubkey_parse(secp256k1_context_static, &pubkey, m_keydata.data());
225 : : }
226 : :
227 : 157 : bool XOnlyPubKey::VerifySchnorr(const uint256& msg, Span<const unsigned char> sigbytes) const
228 : : {
229 [ - + ]: 157 : assert(sigbytes.size() == 64);
230 : 157 : secp256k1_xonly_pubkey pubkey;
231 [ + + ]: 157 : if (!secp256k1_xonly_pubkey_parse(secp256k1_context_static, &pubkey, m_keydata.data())) return false;
232 : 155 : return secp256k1_schnorrsig_verify(secp256k1_context_static, sigbytes.data(), msg.begin(), 32, &pubkey);
233 : : }
234 : :
235 : : static const HashWriter HASHER_TAPTWEAK{TaggedHash("TapTweak")};
236 : :
237 : 75054 : uint256 XOnlyPubKey::ComputeTapTweakHash(const uint256* merkle_root) const
238 : : {
239 [ + + ]: 75054 : if (merkle_root == nullptr) {
240 : : // We have no scripts. The actual tweak does not matter, but follow BIP341 here to
241 : : // allow for reproducible tweaking.
242 : 72081 : return (HashWriter{HASHER_TAPTWEAK} << m_keydata).GetSHA256();
243 : : } else {
244 : 2973 : return (HashWriter{HASHER_TAPTWEAK} << m_keydata << *merkle_root).GetSHA256();
245 : : }
246 : : }
247 : :
248 : 375 : bool XOnlyPubKey::CheckTapTweak(const XOnlyPubKey& internal, const uint256& merkle_root, bool parity) const
249 : : {
250 : 375 : secp256k1_xonly_pubkey internal_key;
251 [ + - ]: 375 : if (!secp256k1_xonly_pubkey_parse(secp256k1_context_static, &internal_key, internal.data())) return false;
252 : 375 : uint256 tweak = internal.ComputeTapTweakHash(&merkle_root);
253 : 375 : return secp256k1_xonly_pubkey_tweak_add_check(secp256k1_context_static, m_keydata.begin(), parity, &internal_key, tweak.begin());
254 : : }
255 : :
256 : 74565 : std::optional<std::pair<XOnlyPubKey, bool>> XOnlyPubKey::CreateTapTweak(const uint256* merkle_root) const
257 : : {
258 : 74565 : secp256k1_xonly_pubkey base_point;
259 [ - + ]: 74565 : if (!secp256k1_xonly_pubkey_parse(secp256k1_context_static, &base_point, data())) return std::nullopt;
260 : 74565 : secp256k1_pubkey out;
261 : 74565 : uint256 tweak = ComputeTapTweakHash(merkle_root);
262 [ - + ]: 74565 : if (!secp256k1_xonly_pubkey_tweak_add(secp256k1_context_static, &out, &base_point, tweak.data())) return std::nullopt;
263 : 74565 : int parity = -1;
264 : 74565 : std::pair<XOnlyPubKey, bool> ret;
265 : 74565 : secp256k1_xonly_pubkey out_xonly;
266 [ - + ]: 74565 : if (!secp256k1_xonly_pubkey_from_pubkey(secp256k1_context_static, &out_xonly, &parity, &out)) return std::nullopt;
267 : 74565 : secp256k1_xonly_pubkey_serialize(secp256k1_context_static, ret.first.begin(), &out_xonly);
268 [ - + ]: 74565 : assert(parity == 0 || parity == 1);
269 : 74565 : ret.second = parity;
270 : 74565 : return ret;
271 : : }
272 : :
273 : :
274 : 22355 : bool CPubKey::Verify(const uint256 &hash, const std::vector<unsigned char>& vchSig) const {
275 [ + - ]: 22355 : if (!IsValid())
276 : : return false;
277 : 22355 : secp256k1_pubkey pubkey;
278 : 22355 : secp256k1_ecdsa_signature sig;
279 [ + - ]: 22355 : if (!secp256k1_ec_pubkey_parse(secp256k1_context_static, &pubkey, vch, size())) {
280 : : return false;
281 : : }
282 [ + + ]: 22355 : if (!ecdsa_signature_parse_der_lax(&sig, vchSig.data(), vchSig.size())) {
283 : : return false;
284 : : }
285 : : /* libsecp256k1's ECDSA verification requires lower-S signatures, which have
286 : : * not historically been enforced in Bitcoin, so normalize them first. */
287 : 22319 : secp256k1_ecdsa_signature_normalize(secp256k1_context_static, &sig, &sig);
288 : 22319 : return secp256k1_ecdsa_verify(secp256k1_context_static, &sig, hash.begin(), &pubkey);
289 : : }
290 : :
291 : 68 : bool CPubKey::RecoverCompact(const uint256 &hash, const std::vector<unsigned char>& vchSig) {
292 [ + - ]: 68 : if (vchSig.size() != COMPACT_SIGNATURE_SIZE)
293 : : return false;
294 : 68 : int recid = (vchSig[0] - 27) & 3;
295 : 68 : bool fComp = ((vchSig[0] - 27) & 4) != 0;
296 : 68 : secp256k1_pubkey pubkey;
297 : 68 : secp256k1_ecdsa_recoverable_signature sig;
298 [ + - ]: 68 : if (!secp256k1_ecdsa_recoverable_signature_parse_compact(secp256k1_context_static, &sig, &vchSig[1], recid)) {
299 : : return false;
300 : : }
301 [ + + ]: 68 : if (!secp256k1_ecdsa_recover(secp256k1_context_static, &pubkey, &sig, hash.begin())) {
302 : : return false;
303 : : }
304 : 67 : unsigned char pub[SIZE];
305 : 67 : size_t publen = SIZE;
306 [ + + ]: 99 : secp256k1_ec_pubkey_serialize(secp256k1_context_static, pub, &publen, &pubkey, fComp ? SECP256K1_EC_COMPRESSED : SECP256K1_EC_UNCOMPRESSED);
307 : 67 : Set(pub, pub + publen);
308 : 67 : return true;
309 : : }
310 : :
311 : 768 : bool CPubKey::IsFullyValid() const {
312 [ + + ]: 768 : if (!IsValid())
313 : : return false;
314 : 722 : secp256k1_pubkey pubkey;
315 : 722 : return secp256k1_ec_pubkey_parse(secp256k1_context_static, &pubkey, vch, size());
316 : : }
317 : :
318 : 4 : bool CPubKey::Decompress() {
319 [ + - ]: 4 : if (!IsValid())
320 : : return false;
321 : 4 : secp256k1_pubkey pubkey;
322 [ + + ]: 4 : if (!secp256k1_ec_pubkey_parse(secp256k1_context_static, &pubkey, vch, size())) {
323 : : return false;
324 : : }
325 : 2 : unsigned char pub[SIZE];
326 : 2 : size_t publen = SIZE;
327 : 2 : secp256k1_ec_pubkey_serialize(secp256k1_context_static, pub, &publen, &pubkey, SECP256K1_EC_UNCOMPRESSED);
328 : 2 : Set(pub, pub + publen);
329 : 2 : return true;
330 : : }
331 : :
332 : 308986 : bool CPubKey::Derive(CPubKey& pubkeyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode& cc) const {
333 [ - + ]: 308986 : assert(IsValid());
334 [ - + ]: 308986 : assert((nChild >> 31) == 0);
335 [ - + ]: 308986 : assert(size() == COMPRESSED_SIZE);
336 : 308986 : unsigned char out[64];
337 : 308986 : BIP32Hash(cc, nChild, *begin(), begin()+1, out);
338 : 308986 : memcpy(ccChild.begin(), out+32, 32);
339 : 308986 : secp256k1_pubkey pubkey;
340 [ + - ]: 308986 : if (!secp256k1_ec_pubkey_parse(secp256k1_context_static, &pubkey, vch, size())) {
341 : : return false;
342 : : }
343 [ + - ]: 308986 : if (!secp256k1_ec_pubkey_tweak_add(secp256k1_context_static, &pubkey, out)) {
344 : : return false;
345 : : }
346 : 308986 : unsigned char pub[COMPRESSED_SIZE];
347 : 308986 : size_t publen = COMPRESSED_SIZE;
348 : 308986 : secp256k1_ec_pubkey_serialize(secp256k1_context_static, pub, &publen, &pubkey, SECP256K1_EC_COMPRESSED);
349 : 308986 : pubkeyChild.Set(pub, pub + publen);
350 : 308986 : return true;
351 : : }
352 : :
353 : 314 : EllSwiftPubKey::EllSwiftPubKey(Span<const std::byte> ellswift) noexcept
354 : : {
355 [ - + ]: 314 : assert(ellswift.size() == SIZE);
356 : 314 : std::copy(ellswift.begin(), ellswift.end(), m_pubkey.begin());
357 : 314 : }
358 : :
359 : 4 : CPubKey EllSwiftPubKey::Decode() const
360 : : {
361 : 4 : secp256k1_pubkey pubkey;
362 : 4 : secp256k1_ellswift_decode(secp256k1_context_static, &pubkey, UCharCast(m_pubkey.data()));
363 : :
364 : 4 : size_t sz = CPubKey::COMPRESSED_SIZE;
365 : 4 : std::array<uint8_t, CPubKey::COMPRESSED_SIZE> vch_bytes;
366 : :
367 : 4 : secp256k1_ec_pubkey_serialize(secp256k1_context_static, vch_bytes.data(), &sz, &pubkey, SECP256K1_EC_COMPRESSED);
368 [ - + ]: 4 : assert(sz == vch_bytes.size());
369 : :
370 : 4 : return CPubKey{vch_bytes.begin(), vch_bytes.end()};
371 : : }
372 : :
373 : 15685 : void CExtPubKey::Encode(unsigned char code[BIP32_EXTKEY_SIZE]) const {
374 : 15685 : code[0] = nDepth;
375 : 15685 : memcpy(code+1, vchFingerprint, 4);
376 : 15685 : WriteBE32(code+5, nChild);
377 [ - + ]: 15685 : memcpy(code+9, chaincode.begin(), 32);
378 [ - + ]: 15685 : assert(pubkey.size() == CPubKey::COMPRESSED_SIZE);
379 : 15685 : memcpy(code+41, pubkey.begin(), CPubKey::COMPRESSED_SIZE);
380 : 15685 : }
381 : :
382 : 476 : void CExtPubKey::Decode(const unsigned char code[BIP32_EXTKEY_SIZE]) {
383 : 476 : nDepth = code[0];
384 : 476 : memcpy(vchFingerprint, code+1, 4);
385 : 476 : nChild = ReadBE32(code+5);
386 : 476 : memcpy(chaincode.begin(), code+9, 32);
387 : 476 : pubkey.Set(code+41, code+BIP32_EXTKEY_SIZE);
388 [ + + + + : 476 : if ((nDepth == 0 && (nChild != 0 || ReadLE32(vchFingerprint) != 0)) || !pubkey.IsFullyValid()) pubkey = CPubKey();
+ + + + ]
389 : 476 : }
390 : :
391 : 0 : void CExtPubKey::EncodeWithVersion(unsigned char code[BIP32_EXTKEY_WITH_VERSION_SIZE]) const
392 : : {
393 : 0 : memcpy(code, version, 4);
394 : 0 : Encode(&code[4]);
395 : 0 : }
396 : :
397 : 0 : void CExtPubKey::DecodeWithVersion(const unsigned char code[BIP32_EXTKEY_WITH_VERSION_SIZE])
398 : : {
399 : 0 : memcpy(version, code, 4);
400 : 0 : Decode(&code[4]);
401 : 0 : }
402 : :
403 : 308987 : bool CExtPubKey::Derive(CExtPubKey &out, unsigned int _nChild) const {
404 [ + + ]: 308987 : if (nDepth == std::numeric_limits<unsigned char>::max()) return false;
405 : 308986 : out.nDepth = nDepth + 1;
406 : 308986 : CKeyID id = pubkey.GetID();
407 : 308986 : memcpy(out.vchFingerprint, &id, 4);
408 : 308986 : out.nChild = _nChild;
409 : 308986 : return pubkey.Derive(out.pubkey, out.chaincode, _nChild, chaincode);
410 : : }
411 : :
412 : 25078 : /* static */ bool CPubKey::CheckLowS(const std::vector<unsigned char>& vchSig) {
413 : 25078 : secp256k1_ecdsa_signature sig;
414 [ + - ]: 25078 : if (!ecdsa_signature_parse_der_lax(&sig, vchSig.data(), vchSig.size())) {
415 : : return false;
416 : : }
417 : 25078 : return (!secp256k1_ecdsa_signature_normalize(secp256k1_context_static, nullptr, &sig));
418 : : }
|
