/Users/eugenesiegel/btc/bitcoin/src/consensus/merkle.cpp
| Line | Count | Source (jump to first uncovered line) | 
| 1 |  | // Copyright (c) 2015-2020 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 <consensus/merkle.h> | 
| 6 |  | #include <hash.h> | 
| 7 |  | #include <util/check.h> | 
| 8 |  |  | 
| 9 |  | /*     WARNING! If you're reading this because you're learning about crypto | 
| 10 |  |        and/or designing a new system that will use merkle trees, keep in mind | 
| 11 |  |        that the following merkle tree algorithm has a serious flaw related to | 
| 12 |  |        duplicate txids, resulting in a vulnerability (CVE-2012-2459). | 
| 13 |  |  | 
| 14 |  |        The reason is that if the number of hashes in the list at a given level | 
| 15 |  |        is odd, the last one is duplicated before computing the next level (which | 
| 16 |  |        is unusual in Merkle trees). This results in certain sequences of | 
| 17 |  |        transactions leading to the same merkle root. For example, these two | 
| 18 |  |        trees: | 
| 19 |  |  | 
| 20 |  |                     A               A | 
| 21 |  |                   /  \            /   \ | 
| 22 |  |                 B     C         B       C | 
| 23 |  |                / \    |        / \     / \ | 
| 24 |  |               D   E   F       D   E   F   F | 
| 25 |  |              / \ / \ / \     / \ / \ / \ / \ | 
| 26 |  |              1 2 3 4 5 6     1 2 3 4 5 6 5 6 | 
| 27 |  |  | 
| 28 |  |        for transaction lists [1,2,3,4,5,6] and [1,2,3,4,5,6,5,6] (where 5 and | 
| 29 |  |        6 are repeated) result in the same root hash A (because the hash of both | 
| 30 |  |        of (F) and (F,F) is C). | 
| 31 |  |  | 
| 32 |  |        The vulnerability results from being able to send a block with such a | 
| 33 |  |        transaction list, with the same merkle root, and the same block hash as | 
| 34 |  |        the original without duplication, resulting in failed validation. If the | 
| 35 |  |        receiving node proceeds to mark that block as permanently invalid | 
| 36 |  |        however, it will fail to accept further unmodified (and thus potentially | 
| 37 |  |        valid) versions of the same block. We defend against this by detecting | 
| 38 |  |        the case where we would hash two identical hashes at the end of the list | 
| 39 |  |        together, and treating that identically to the block having an invalid | 
| 40 |  |        merkle root. Assuming no double-SHA256 collisions, this will detect all | 
| 41 |  |        known ways of changing the transactions without affecting the merkle | 
| 42 |  |        root. | 
| 43 |  | */ | 
| 44 |  |  | 
| 45 |  |  | 
| 46 | 4.68M | uint256 ComputeMerkleRoot(std::vector<uint256> hashes, bool* mutated) { | 
| 47 | 4.68M |     bool mutation = false; | 
| 48 | 8.26M |     while (hashes.size() > 1) { | 
| 49 | 3.57M |         if (mutated) { | 
| 50 | 5.93M |             for (size_t pos = 0; pos + 1 < hashes.size(); pos += 24.14M) { | 
| 51 | 4.14M |                 if (hashes[pos] == hashes[pos + 1]) mutation = true687k; | 
| 52 | 4.14M |             } | 
| 53 | 1.78M |         } | 
| 54 | 3.57M |         if (hashes.size() & 1) { | 
| 55 | 1.57M |             hashes.push_back(hashes.back()); | 
| 56 | 1.57M |         } | 
| 57 | 3.57M |         SHA256D64(hashes[0].begin(), hashes[0].begin(), hashes.size() / 2); | 
| 58 | 3.57M |         hashes.resize(hashes.size() / 2); | 
| 59 | 3.57M |     } | 
| 60 | 4.68M |     if (mutated) *mutated = mutation2.34M; | 
| 61 | 4.68M |     if (hashes.size() == 0) return uint256()0; | 
| 62 | 4.68M |     return hashes[0]; | 
| 63 | 4.68M | } | 
| 64 |  |  | 
| 65 |  |  | 
| 66 |  | uint256 BlockMerkleRoot(const CBlock& block, bool* mutated) | 
| 67 | 2.65M | { | 
| 68 | 2.65M |     std::vector<uint256> leaves; | 
| 69 | 2.65M |     leaves.resize(block.vtx.size()); | 
| 70 | 9.44M |     for (size_t s = 0; s < block.vtx.size(); s++6.79M) { | 
| 71 | 6.79M |         leaves[s] = block.vtx[s]->GetHash().ToUint256(); | 
| 72 | 6.79M |     } | 
| 73 | 2.65M |     return ComputeMerkleRoot(std::move(leaves), mutated); | 
| 74 | 2.65M | } | 
| 75 |  |  | 
| 76 |  | uint256 BlockWitnessMerkleRoot(const CBlock& block, bool* mutated) | 
| 77 | 2.03M | { | 
| 78 | 2.03M |     std::vector<uint256> leaves; | 
| 79 | 2.03M |     leaves.resize(block.vtx.size()); | 
| 80 | 2.03M |     leaves[0].SetNull(); // The witness hash of the coinbase is 0. | 
| 81 | 6.16M |     for (size_t s = 1; s < block.vtx.size(); s++4.13M) { | 
| 82 | 4.13M |         leaves[s] = block.vtx[s]->GetWitnessHash().ToUint256(); | 
| 83 | 4.13M |     } | 
| 84 | 2.03M |     return ComputeMerkleRoot(std::move(leaves), mutated); | 
| 85 | 2.03M | } | 
| 86 |  |  | 
| 87 |  | /* This implements a constant-space merkle root/path calculator, limited to 2^32 leaves. */ | 
| 88 |  | static void MerkleComputation(const std::vector<uint256>& leaves, uint256* proot, bool* pmutated, uint32_t leaf_pos, std::vector<uint256>* path) | 
| 89 | 0 | { | 
| 90 | 0 |     if (path) path->clear(); | 
| 91 | 0 |     Assume(leaves.size() <= UINT32_MAX); | Line | Count | Source |  | 118 | 0 | #define Assume(val) inline_assertion_check<false>(val, __FILE__, __LINE__, __func__, #val) | 
 | 
| 92 | 0 |     if (leaves.size() == 0) { | 
| 93 | 0 |         if (pmutated) *pmutated = false; | 
| 94 | 0 |         if (proot) *proot = uint256(); | 
| 95 | 0 |         return; | 
| 96 | 0 |     } | 
| 97 | 0 |     bool mutated = false; | 
| 98 |  |     // count is the number of leaves processed so far. | 
| 99 | 0 |     uint32_t count = 0; | 
| 100 |  |     // inner is an array of eagerly computed subtree hashes, indexed by tree | 
| 101 |  |     // level (0 being the leaves). | 
| 102 |  |     // For example, when count is 25 (11001 in binary), inner[4] is the hash of | 
| 103 |  |     // the first 16 leaves, inner[3] of the next 8 leaves, and inner[0] equal to | 
| 104 |  |     // the last leaf. The other inner entries are undefined. | 
| 105 | 0 |     uint256 inner[32]; | 
| 106 |  |     // Which position in inner is a hash that depends on the matching leaf. | 
| 107 | 0 |     int matchlevel = -1; | 
| 108 |  |     // First process all leaves into 'inner' values. | 
| 109 | 0 |     while (count < leaves.size()) { | 
| 110 | 0 |         uint256 h = leaves[count]; | 
| 111 | 0 |         bool matchh = count == leaf_pos; | 
| 112 | 0 |         count++; | 
| 113 | 0 |         int level; | 
| 114 |  |         // For each of the lower bits in count that are 0, do 1 step. Each | 
| 115 |  |         // corresponds to an inner value that existed before processing the | 
| 116 |  |         // current leaf, and each needs a hash to combine it. | 
| 117 | 0 |         for (level = 0; !(count & ((uint32_t{1}) << level)); level++) { | 
| 118 | 0 |             if (path) { | 
| 119 | 0 |                 if (matchh) { | 
| 120 | 0 |                     path->push_back(inner[level]); | 
| 121 | 0 |                 } else if (matchlevel == level) { | 
| 122 | 0 |                     path->push_back(h); | 
| 123 | 0 |                     matchh = true; | 
| 124 | 0 |                 } | 
| 125 | 0 |             } | 
| 126 | 0 |             mutated |= (inner[level] == h); | 
| 127 | 0 |             h = Hash(inner[level], h); | 
| 128 | 0 |         } | 
| 129 |  |         // Store the resulting hash at inner position level. | 
| 130 | 0 |         inner[level] = h; | 
| 131 | 0 |         if (matchh) { | 
| 132 | 0 |             matchlevel = level; | 
| 133 | 0 |         } | 
| 134 | 0 |     } | 
| 135 |  |     // Do a final 'sweep' over the rightmost branch of the tree to process | 
| 136 |  |     // odd levels, and reduce everything to a single top value. | 
| 137 |  |     // Level is the level (counted from the bottom) up to which we've sweeped. | 
| 138 | 0 |     int level = 0; | 
| 139 |  |     // As long as bit number level in count is zero, skip it. It means there | 
| 140 |  |     // is nothing left at this level. | 
| 141 | 0 |     while (!(count & ((uint32_t{1}) << level))) { | 
| 142 | 0 |         level++; | 
| 143 | 0 |     } | 
| 144 | 0 |     uint256 h = inner[level]; | 
| 145 | 0 |     bool matchh = matchlevel == level; | 
| 146 | 0 |     while (count != ((uint32_t{1}) << level)) { | 
| 147 |  |         // If we reach this point, h is an inner value that is not the top. | 
| 148 |  |         // We combine it with itself (Bitcoin's special rule for odd levels in | 
| 149 |  |         // the tree) to produce a higher level one. | 
| 150 | 0 |         if (path && matchh) { | 
| 151 | 0 |             path->push_back(h); | 
| 152 | 0 |         } | 
| 153 | 0 |         h = Hash(h, h); | 
| 154 |  |         // Increment count to the value it would have if two entries at this | 
| 155 |  |         // level had existed. | 
| 156 | 0 |         count += ((uint32_t{1}) << level); | 
| 157 | 0 |         level++; | 
| 158 |  |         // And propagate the result upwards accordingly. | 
| 159 | 0 |         while (!(count & ((uint32_t{1}) << level))) { | 
| 160 | 0 |             if (path) { | 
| 161 | 0 |                 if (matchh) { | 
| 162 | 0 |                     path->push_back(inner[level]); | 
| 163 | 0 |                 } else if (matchlevel == level) { | 
| 164 | 0 |                     path->push_back(h); | 
| 165 | 0 |                     matchh = true; | 
| 166 | 0 |                 } | 
| 167 | 0 |             } | 
| 168 | 0 |             h = Hash(inner[level], h); | 
| 169 | 0 |             level++; | 
| 170 | 0 |         } | 
| 171 | 0 |     } | 
| 172 |  |     // Return result. | 
| 173 | 0 |     if (pmutated) *pmutated = mutated; | 
| 174 | 0 |     if (proot) *proot = h; | 
| 175 | 0 | } | 
| 176 |  |  | 
| 177 | 0 | static std::vector<uint256> ComputeMerklePath(const std::vector<uint256>& leaves, uint32_t position) { | 
| 178 | 0 |     std::vector<uint256> ret; | 
| 179 | 0 |     MerkleComputation(leaves, nullptr, nullptr, position, &ret); | 
| 180 | 0 |     return ret; | 
| 181 | 0 | } | 
| 182 |  |  | 
| 183 |  | std::vector<uint256> TransactionMerklePath(const CBlock& block, uint32_t position) | 
| 184 | 0 | { | 
| 185 | 0 |     std::vector<uint256> leaves; | 
| 186 | 0 |     leaves.resize(block.vtx.size()); | 
| 187 | 0 |     for (size_t s = 0; s < block.vtx.size(); s++) { | 
| 188 | 0 |         leaves[s] = block.vtx[s]->GetHash().ToUint256(); | 
| 189 | 0 |     } | 
| 190 | 0 |     return ComputeMerklePath(leaves, position); | 
| 191 | 0 | } |