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