Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 The Bitcoin Core developers
3 : : // Copyright (c) 2017 The Zcash developers
4 : : // Distributed under the MIT software license, see the accompanying
5 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
6 : :
7 : : #ifndef BITCOIN_PUBKEY_H
8 : : #define BITCOIN_PUBKEY_H
9 : :
10 : : #include <hash.h>
11 : : #include <serialize.h>
12 : : #include <span.h>
13 : : #include <uint256.h>
14 : :
15 : : #include <cstring>
16 : : #include <optional>
17 : : #include <vector>
18 : :
19 : : const unsigned int BIP32_EXTKEY_SIZE = 74;
20 : : const unsigned int BIP32_EXTKEY_WITH_VERSION_SIZE = 78;
21 : :
22 : : /** A reference to a CKey: the Hash160 of its serialized public key */
23 : : class CKeyID : public uint160
24 : : {
25 : : public:
26 : 0 : CKeyID() : uint160() {}
27 : 96984 : explicit CKeyID(const uint160& in) : uint160(in) {}
28 : : };
29 : :
30 : : typedef uint256 ChainCode;
31 : :
32 : : /** An encapsulated public key. */
33 : : class CPubKey
34 : : {
35 : : public:
36 : : /**
37 : : * secp256k1:
38 : : */
39 : : static constexpr unsigned int SIZE = 65;
40 : : static constexpr unsigned int COMPRESSED_SIZE = 33;
41 : : static constexpr unsigned int SIGNATURE_SIZE = 72;
42 : : static constexpr unsigned int COMPACT_SIGNATURE_SIZE = 65;
43 : : /**
44 : : * see www.keylength.com
45 : : * script supports up to 75 for single byte push
46 : : */
47 : : static_assert(
48 : : SIZE >= COMPRESSED_SIZE,
49 : : "COMPRESSED_SIZE is larger than SIZE");
50 : :
51 : : private:
52 : :
53 : : /**
54 : : * Just store the serialized data.
55 : : * Its length can very cheaply be computed from the first byte.
56 : : */
57 : : unsigned char vch[SIZE];
58 : :
59 : : //! Compute the length of a pubkey with a given first byte.
60 : 266186 : unsigned int static GetLen(unsigned char chHeader)
61 : : {
62 [ + + ][ + + ]: 266186 : if (chHeader == 2 || chHeader == 3)
63 : 260884 : return COMPRESSED_SIZE;
64 [ + + ][ + + ]: 5302 : if (chHeader == 4 || chHeader == 6 || chHeader == 7)
[ - + ]
65 : 837 : return SIZE;
66 : 4465 : return 0;
67 : 266186 : }
68 : :
69 : : //! Set this key data to be invalid
70 : 111885 : void Invalidate()
71 : : {
72 : 111885 : vch[0] = 0xFF;
73 : 111885 : }
74 : :
75 : : public:
76 : :
77 : 851 : bool static ValidSize(const std::vector<unsigned char> &vch) {
78 [ + + ]: 851 : return vch.size() > 0 && GetLen(vch[0]) == vch.size();
79 : : }
80 : :
81 : : //! Construct an invalid public key.
82 : 111796 : CPubKey()
83 : : {
84 : 111796 : Invalidate();
85 : 111796 : }
86 : :
87 : : //! Initialize a public key using begin/end iterators to byte data.
88 : : template <typename T>
89 : 28032 : void Set(const T pbegin, const T pend)
90 : : {
91 [ + + ][ + - ]: 28032 : int len = pend == pbegin ? 0 : GetLen(pbegin[0]);
[ # # ]
92 [ + - ][ + - ]: 28032 : if (len && len == (pend - pbegin))
[ + + ][ + - ]
[ # # ][ # # ]
93 : 27943 : memcpy(vch, (unsigned char*)&pbegin[0], len);
94 : : else
95 : 89 : Invalidate();
96 : 28032 : }
97 : :
98 : : //! Construct a public key using begin/end iterators to byte data.
99 : : template <typename T>
100 : 349 : CPubKey(const T pbegin, const T pend)
101 : : {
102 : 349 : Set(pbegin, pend);
103 : 349 : }
104 : :
105 : : //! Construct a public key from a byte vector.
106 : 7875 : explicit CPubKey(Span<const uint8_t> _vch)
107 : : {
108 : 7875 : Set(_vch.begin(), _vch.end());
109 : 7875 : }
110 : :
111 : : //! Simple read-only vector-like interface to the pubkey data.
112 : 237351 : unsigned int size() const { return GetLen(vch[0]); }
113 : 16106 : const unsigned char* data() const { return vch; }
114 : 62185 : const unsigned char* begin() const { return vch; }
115 : 2204 : const unsigned char* end() const { return vch + size(); }
116 : 0 : const unsigned char& operator[](unsigned int pos) const { return vch[pos]; }
117 : :
118 : : //! Comparator implementation.
119 : 0 : friend bool operator==(const CPubKey& a, const CPubKey& b)
120 : : {
121 [ # # ]: 0 : return a.vch[0] == b.vch[0] &&
122 : 0 : memcmp(a.vch, b.vch, a.size()) == 0;
123 : : }
124 : 0 : friend bool operator!=(const CPubKey& a, const CPubKey& b)
125 : : {
126 : 0 : return !(a == b);
127 : : }
128 : 11091 : friend bool operator<(const CPubKey& a, const CPubKey& b)
129 : : {
130 [ + + ]: 20970 : return a.vch[0] < b.vch[0] ||
131 [ + + ]: 9879 : (a.vch[0] == b.vch[0] && memcmp(a.vch, b.vch, a.size()) < 0);
132 : : }
133 : 0 : friend bool operator>(const CPubKey& a, const CPubKey& b)
134 : : {
135 [ # # ]: 0 : return a.vch[0] > b.vch[0] ||
136 [ # # ]: 0 : (a.vch[0] == b.vch[0] && memcmp(a.vch, b.vch, a.size()) > 0);
137 : : }
138 : :
139 : : //! Implement serialization, as if this was a byte vector.
140 : : template <typename Stream>
141 : 0 : void Serialize(Stream& s) const
142 : : {
143 : 0 : unsigned int len = size();
144 : 0 : ::WriteCompactSize(s, len);
145 : 0 : s << Span{vch, len};
146 : 0 : }
147 : : template <typename Stream>
148 : 0 : void Unserialize(Stream& s)
149 : : {
150 : 0 : const unsigned int len(::ReadCompactSize(s));
151 [ # # ]: 0 : if (len <= SIZE) {
152 : 0 : s >> Span{vch, len};
153 [ # # ]: 0 : if (len != size()) {
154 : 0 : Invalidate();
155 : 0 : }
156 : 0 : } else {
157 : : // invalid pubkey, skip available data
158 : 0 : s.ignore(len);
159 : 0 : Invalidate();
160 : : }
161 : 0 : }
162 : :
163 : : //! Get the KeyID of this public key (hash of its serialization)
164 : 96865 : CKeyID GetID() const
165 : : {
166 : 96865 : return CKeyID(Hash160(Span{vch}.first(size())));
167 : : }
168 : :
169 : : //! Get the 256-bit hash of this public key.
170 : 0 : uint256 GetHash() const
171 : : {
172 : 0 : return Hash(Span{vch}.first(size()));
173 : : }
174 : :
175 : : /*
176 : : * Check syntactic correctness.
177 : : *
178 : : * When setting a pubkey (Set()) or deserializing fails (its header bytes
179 : : * don't match the length of the data), the size is set to 0. Thus,
180 : : * by checking size, one can observe whether Set() or deserialization has
181 : : * failed.
182 : : *
183 : : * This does not check for more than that. In particular, it does not verify
184 : : * that the coordinates correspond to a point on the curve (see IsFullyValid()
185 : : * for that instead).
186 : : *
187 : : * Note that this is consensus critical as CheckECDSASignature() calls it!
188 : : */
189 : 45520 : bool IsValid() const
190 : : {
191 : 45520 : return size() > 0;
192 : : }
193 : :
194 : : /** Check if a public key is a syntactically valid compressed or uncompressed key. */
195 : 2867 : bool IsValidNonHybrid() const noexcept
196 : : {
197 [ - + ][ + + ]: 5734 : return size() > 0 && (vch[0] == 0x02 || vch[0] == 0x03 || vch[0] == 0x04);
[ + + ]
198 : : }
199 : :
200 : : //! fully validate whether this is a valid public key (more expensive than IsValid())
201 : : bool IsFullyValid() const;
202 : :
203 : : //! Check whether this is a compressed public key.
204 : 2611 : bool IsCompressed() const
205 : : {
206 : 2611 : return size() == COMPRESSED_SIZE;
207 : : }
208 : :
209 : : /**
210 : : * Verify a DER signature (~72 bytes).
211 : : * If this public key is not fully valid, the return value will be false.
212 : : */
213 : : bool Verify(const uint256& hash, const std::vector<unsigned char>& vchSig) const;
214 : :
215 : : /**
216 : : * Check whether a signature is normalized (lower-S).
217 : : */
218 : : static bool CheckLowS(const std::vector<unsigned char>& vchSig);
219 : :
220 : : //! Recover a public key from a compact signature.
221 : : bool RecoverCompact(const uint256& hash, const std::vector<unsigned char>& vchSig);
222 : :
223 : : //! Turn this public key into an uncompressed public key.
224 : : bool Decompress();
225 : :
226 : : //! Derive BIP32 child pubkey.
227 : : [[nodiscard]] bool Derive(CPubKey& pubkeyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode& cc) const;
228 : : };
229 : :
230 : : class XOnlyPubKey
231 : : {
232 : : private:
233 : : uint256 m_keydata;
234 : :
235 : : public:
236 : : /** Construct an empty x-only pubkey. */
237 : 1242 : XOnlyPubKey() = default;
238 : :
239 : : XOnlyPubKey(const XOnlyPubKey&) = default;
240 : : XOnlyPubKey& operator=(const XOnlyPubKey&) = default;
241 : :
242 : : /** Determine if this pubkey is fully valid. This is true for approximately 50% of all
243 : : * possible 32-byte arrays. If false, VerifySchnorr, CheckTapTweak and CreateTapTweak
244 : : * will always fail. */
245 : : bool IsFullyValid() const;
246 : :
247 : : /** Test whether this is the 0 key (the result of default construction). This implies
248 : : * !IsFullyValid(). */
249 : 0 : bool IsNull() const { return m_keydata.IsNull(); }
250 : :
251 : : /** Construct an x-only pubkey from exactly 32 bytes. */
252 : : explicit XOnlyPubKey(Span<const unsigned char> bytes);
253 : :
254 : : /** Construct an x-only pubkey from a normal pubkey. */
255 : 10831 : explicit XOnlyPubKey(const CPubKey& pubkey) : XOnlyPubKey(Span{pubkey}.subspan(1, 32)) {}
256 : :
257 : : /** Verify a Schnorr signature against this public key.
258 : : *
259 : : * sigbytes must be exactly 64 bytes.
260 : : */
261 : : bool VerifySchnorr(const uint256& msg, Span<const unsigned char> sigbytes) const;
262 : :
263 : : /** Compute the Taproot tweak as specified in BIP341, with *this as internal
264 : : * key:
265 : : * - if merkle_root == nullptr: H_TapTweak(xonly_pubkey)
266 : : * - otherwise: H_TapTweak(xonly_pubkey || *merkle_root)
267 : : *
268 : : * Note that the behavior of this function with merkle_root != nullptr is
269 : : * consensus critical.
270 : : */
271 : : uint256 ComputeTapTweakHash(const uint256* merkle_root) const;
272 : :
273 : : /** Verify that this is a Taproot tweaked output point, against a specified internal key,
274 : : * Merkle root, and parity. */
275 : : bool CheckTapTweak(const XOnlyPubKey& internal, const uint256& merkle_root, bool parity) const;
276 : :
277 : : /** Construct a Taproot tweaked output point with this point as internal key. */
278 : : std::optional<std::pair<XOnlyPubKey, bool>> CreateTapTweak(const uint256* merkle_root) const;
279 : :
280 : : /** Returns a list of CKeyIDs for the CPubKeys that could have been used to create this XOnlyPubKey.
281 : : * This is needed for key lookups since keys are indexed by CKeyID.
282 : : */
283 : : std::vector<CKeyID> GetKeyIDs() const;
284 : :
285 : : CPubKey GetEvenCorrespondingCPubKey() const;
286 : :
287 : : const unsigned char& operator[](int pos) const { return *(m_keydata.begin() + pos); }
288 : 389 : const unsigned char* data() const { return m_keydata.begin(); }
289 : 131 : static constexpr size_t size() { return decltype(m_keydata)::size(); }
290 : 16106 : const unsigned char* begin() const { return m_keydata.begin(); }
291 : 16106 : const unsigned char* end() const { return m_keydata.end(); }
292 : 379 : unsigned char* begin() { return m_keydata.begin(); }
293 : : unsigned char* end() { return m_keydata.end(); }
294 : 0 : bool operator==(const XOnlyPubKey& other) const { return m_keydata == other.m_keydata; }
295 : 86 : bool operator!=(const XOnlyPubKey& other) const { return m_keydata != other.m_keydata; }
296 : 344 : bool operator<(const XOnlyPubKey& other) const { return m_keydata < other.m_keydata; }
297 : :
298 : : //! Implement serialization without length prefixes since it is a fixed length
299 : 0 : SERIALIZE_METHODS(XOnlyPubKey, obj) { READWRITE(obj.m_keydata); }
300 : : };
301 : :
302 : : /** An ElligatorSwift-encoded public key. */
303 : : struct EllSwiftPubKey
304 : : {
305 : : private:
306 : : static constexpr size_t SIZE = 64;
307 : : std::array<std::byte, SIZE> m_pubkey;
308 : :
309 : : public:
310 : : /** Default constructor creates all-zero pubkey (which is valid). */
311 : : EllSwiftPubKey() noexcept = default;
312 : :
313 : : /** Construct a new ellswift public key from a given serialization. */
314 : : EllSwiftPubKey(Span<const std::byte> ellswift) noexcept;
315 : :
316 : : /** Decode to normal compressed CPubKey (for debugging purposes). */
317 : : CPubKey Decode() const;
318 : :
319 : : // Read-only access for serialization.
320 : 0 : const std::byte* data() const { return m_pubkey.data(); }
321 : 0 : static constexpr size_t size() { return SIZE; }
322 : 0 : auto begin() const { return m_pubkey.cbegin(); }
323 : 0 : auto end() const { return m_pubkey.cend(); }
324 : :
325 : 0 : bool friend operator==(const EllSwiftPubKey& a, const EllSwiftPubKey& b)
326 : : {
327 : 0 : return a.m_pubkey == b.m_pubkey;
328 : : }
329 : :
330 : 0 : bool friend operator!=(const EllSwiftPubKey& a, const EllSwiftPubKey& b)
331 : : {
332 : 0 : return a.m_pubkey != b.m_pubkey;
333 : : }
334 : : };
335 : :
336 : 0 : struct CExtPubKey {
337 : : unsigned char version[4];
338 : : unsigned char nDepth;
339 : : unsigned char vchFingerprint[4];
340 : : unsigned int nChild;
341 : : ChainCode chaincode;
342 : : CPubKey pubkey;
343 : :
344 : 0 : friend bool operator==(const CExtPubKey &a, const CExtPubKey &b)
345 : : {
346 [ # # ]: 0 : return a.nDepth == b.nDepth &&
347 [ # # ]: 0 : memcmp(a.vchFingerprint, b.vchFingerprint, sizeof(vchFingerprint)) == 0 &&
348 [ # # ]: 0 : a.nChild == b.nChild &&
349 [ # # ]: 0 : a.chaincode == b.chaincode &&
350 : 0 : a.pubkey == b.pubkey;
351 : : }
352 : :
353 : 0 : friend bool operator!=(const CExtPubKey &a, const CExtPubKey &b)
354 : : {
355 : 0 : return !(a == b);
356 : : }
357 : :
358 : 0 : friend bool operator<(const CExtPubKey &a, const CExtPubKey &b)
359 : : {
360 [ # # ]: 0 : if (a.pubkey < b.pubkey) {
361 : 0 : return true;
362 [ # # ]: 0 : } else if (a.pubkey > b.pubkey) {
363 : 0 : return false;
364 : : }
365 : 0 : return a.chaincode < b.chaincode;
366 : 0 : }
367 : :
368 : : void Encode(unsigned char code[BIP32_EXTKEY_SIZE]) const;
369 : : void Decode(const unsigned char code[BIP32_EXTKEY_SIZE]);
370 : : void EncodeWithVersion(unsigned char code[BIP32_EXTKEY_WITH_VERSION_SIZE]) const;
371 : : void DecodeWithVersion(const unsigned char code[BIP32_EXTKEY_WITH_VERSION_SIZE]);
372 : : [[nodiscard]] bool Derive(CExtPubKey& out, unsigned int nChild) const;
373 : : };
374 : :
375 : : #endif // BITCOIN_PUBKEY_H
|
