Bitcoin Core Fuzz Coverage Report for wallet_tx_can_be_bumped

Coverage Report

Created: 2025-11-19 11:20

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/Users/brunogarcia/projects/bitcoin-core-dev/src/util/obfuscation.h
Line
Count
Source
1
// Copyright (c) 2025-present 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
#ifndef BITCOIN_UTIL_OBFUSCATION_H
6
#define BITCOIN_UTIL_OBFUSCATION_H
7
8
#include <cstdint>
9
#include <span.h>
10
#include <tinyformat.h>
11
#include <util/strencodings.h>
12
13
#include <array>
14
#include <bit>
15
#include <climits>
16
#include <ios>
17
#include <memory>
18
19
class Obfuscation
20
{
21
public:
22
    using KeyType = uint64_t;
23
    static constexpr size_t KEY_SIZE{sizeof(KeyType)};
24
25
0
    Obfuscation() { SetRotations(0); }
26
    explicit Obfuscation(std::span<const std::byte, KEY_SIZE> key_bytes)
27
0
    {
28
0
        SetRotations(ToKey(key_bytes));
29
0
    }
30
31
0
    operator bool() const { return m_rotations[0] != 0; }
32
33
    void operator()(std::span<std::byte> target, size_t key_offset = 0) const
34
0
    {
35
0
        if (!*this) return;
36
37
0
        KeyType rot_key{m_rotations[key_offset % KEY_SIZE]}; // Continue obfuscation from where we left off
38
0
        if (target.size() > KEY_SIZE) {
39
            // Obfuscate until KEY_SIZE alignment boundary
40
0
            if (const auto misalign{reinterpret_cast<uintptr_t>(target.data()) % KEY_SIZE}) {
41
0
                const size_t alignment{KEY_SIZE - misalign};
42
0
                XorWord(target.first(alignment), rot_key);
43
44
0
                target = {std::assume_aligned<KEY_SIZE>(target.data() + alignment), target.size() - alignment};
45
0
                rot_key = m_rotations[(key_offset + alignment) % KEY_SIZE];
46
0
            }
47
            // Aligned obfuscation in 8*KEY_SIZE chunks
48
0
            for (constexpr auto unroll{8}; target.size() >= KEY_SIZE * unroll; target = target.subspan(KEY_SIZE * unroll)) {
49
0
                for (size_t i{0}; i < unroll; ++i) {
50
0
                    XorWord(target.subspan(i * KEY_SIZE, KEY_SIZE), rot_key);
51
0
                }
52
0
            }
53
            // Aligned obfuscation in KEY_SIZE chunks
54
0
            for (; target.size() >= KEY_SIZE; target = target.subspan(KEY_SIZE)) {
55
0
                XorWord(target.first<KEY_SIZE>(), rot_key);
56
0
            }
57
0
        }
58
0
        XorWord(target, rot_key);
59
0
    }
60
61
    template <typename Stream>
62
    void Serialize(Stream& s) const
63
0
    {
64
        // Use vector serialization for convenient compact size prefix.
65
0
        std::vector<std::byte> bytes{KEY_SIZE};
66
0
        std::memcpy(bytes.data(), &m_rotations[0], KEY_SIZE);
67
0
        s << bytes;
68
0
    }
Unexecuted instantiation: void Obfuscation::Serialize<DataStream>(DataStream&) const
Unexecuted instantiation: void Obfuscation::Serialize<AutoFile>(AutoFile&) const
69
70
    template <typename Stream>
71
    void Unserialize(Stream& s)
72
0
    {
73
0
        std::vector<std::byte> bytes{KEY_SIZE};
74
0
        s >> bytes;
75
0
        if (bytes.size() != KEY_SIZE) throw std::ios_base::failure(strprintf("Obfuscation key size should be exactly %s bytes long", KEY_SIZE));
Line
Count
Source
1172
0
#define strprintf tfm::format
        if (bytes.size() != KEY_SIZE) throw std::ios_base::failure(strprintf("Obfuscation key size should be exactly %s bytes long", KEY_SIZE));
Line
Count
Source
1172
0
#define strprintf tfm::format
76
0
        SetRotations(ToKey(std::span<std::byte, KEY_SIZE>(bytes)));
77
0
    }
Unexecuted instantiation: void Obfuscation::Unserialize<DataStream>(DataStream&)
Unexecuted instantiation: void Obfuscation::Unserialize<AutoFile>(AutoFile&)
78
79
    std::string HexKey() const
80
0
    {
81
0
        return HexStr(std::as_bytes(std::span{&m_rotations[0], 1}));
82
0
    }
83
84
private:
85
    // Cached key rotations for different offsets.
86
    std::array<KeyType, KEY_SIZE> m_rotations;
87
88
    void SetRotations(KeyType key)
89
0
    {
90
0
        for (size_t i{0}; i < KEY_SIZE; ++i) {
91
0
            int key_rotation_bits{int(CHAR_BIT * i)};
92
            if constexpr (std::endian::native == std::endian::big) key_rotation_bits *= -1;
93
0
            m_rotations[i] = std::rotr(key, key_rotation_bits);
94
0
        }
95
0
    }
96
97
    static KeyType ToKey(std::span<const std::byte, KEY_SIZE> key_span)
98
0
    {
99
0
        KeyType key{};
100
0
        std::memcpy(&key, key_span.data(), KEY_SIZE);
101
0
        return key;
102
0
    }
103
104
    static void XorWord(std::span<std::byte> target, KeyType key)
105
0
    {
106
0
        assert(target.size() <= KEY_SIZE);
107
0
        if (target.empty()) return;
108
0
        KeyType raw{};
109
0
        std::memcpy(&raw, target.data(), target.size());
110
0
        raw ^= key;
111
0
        std::memcpy(target.data(), &raw, target.size());
112
0
    }
113
};
114
115
#endif // BITCOIN_UTIL_OBFUSCATION_H