Coverage Report

Created: 2026-07-23 20:35

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/external_signer.cpp
Line
Count
Source
1
// Copyright (c) 2018-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
#include <external_signer.h>
6
7
#include <chainparams.h>
8
#include <common/run_command.h>
9
#include <core_io.h>
10
#include <psbt.h>
11
#include <util/strencodings.h>
12
#include <util/subprocess.h>
13
14
#include <algorithm>
15
#include <stdexcept>
16
#include <string>
17
#include <vector>
18
19
ExternalSigner::ExternalSigner(std::vector<std::string> command, std::string chain, std::string fingerprint, std::string name)
20
15
    : m_command{std::move(command)}, m_chain{std::move(chain)}, m_fingerprint{std::move(fingerprint)}, m_name{std::move(name)} {}
21
22
std::vector<std::string> ExternalSigner::NetworkArg() const
23
10
{
24
10
    return {"--chain", m_chain};
25
10
}
26
27
bool ExternalSigner::Enumerate(const std::string& command, std::vector<ExternalSigner>& signers, const std::string& chain)
28
24
{
29
    // Call <command> enumerate
30
24
    std::vector<std::string> cmd_args = Cat(subprocess::util::split(command), {"enumerate"});
31
32
24
    const UniValue result = RunCommandParseJSON(cmd_args, "");
33
24
    if (!result.isArray()) {
34
0
        throw std::runtime_error(strprintf("'%s' received invalid response, expected array of signers", command));
35
0
    }
36
24
    for (const UniValue& signer : result.getValues()) {
37
        // Check for error
38
22
        const UniValue& error = signer.find_value("error");
39
22
        if (!error.isNull()) {
40
1
            if (!error.isStr()) {
41
0
                throw std::runtime_error(strprintf("'%s' error", command));
42
0
            }
43
1
            throw std::runtime_error(strprintf("'%s' error: %s", command, error.getValStr()));
44
1
        }
45
        // Check if fingerprint is present
46
21
        const UniValue& fingerprint = signer.find_value("fingerprint");
47
21
        if (fingerprint.isNull()) {
48
0
            throw std::runtime_error(strprintf("'%s' received invalid response, missing signer fingerprint", command));
49
0
        }
50
21
        const std::string& fingerprintStr{fingerprint.get_str()};
51
21
        if (fingerprintStr.size() != 8 || !IsHex(fingerprintStr)) {
52
5
            throw std::runtime_error(strprintf("'%s' received invalid fingerprint, must be 8 hex characters", command));
53
5
        }
54
        // Skip duplicate signer
55
16
        bool duplicate = false;
56
16
        for (const ExternalSigner& signer : signers) {
57
3
            if (signer.m_fingerprint.compare(fingerprintStr) == 0) duplicate = true;
58
3
        }
59
16
        if (duplicate) continue;
60
15
        std::string name;
61
15
        const UniValue& model_field = signer.find_value("model");
62
15
        if (model_field.isStr() && model_field.getValStr() != "") {
63
15
            name += model_field.getValStr();
64
15
        }
65
15
        signers.emplace_back(subprocess::util::split(command), chain, fingerprintStr, name);
66
15
    }
67
18
    return true;
68
24
}
69
70
UniValue ExternalSigner::DisplayAddress(const std::string& descriptor) const
71
4
{
72
4
    return RunCommandParseJSON(Cat(m_command, Cat(Cat({"--fingerprint", m_fingerprint}, NetworkArg()), {"displayaddress", "--desc", descriptor})), "");
73
4
}
74
75
UniValue ExternalSigner::GetDescriptors(const int account)
76
3
{
77
3
    return RunCommandParseJSON(Cat(m_command, Cat(Cat({"--fingerprint", m_fingerprint}, NetworkArg()), {"getdescriptors", "--account", strprintf("%d", account)})), "");
78
3
}
79
80
bool ExternalSigner::SignTransaction(PartiallySignedTransaction& psbtx, std::string& error)
81
3
{
82
    // Serialize the PSBT
83
3
    DataStream ssTx{};
84
3
    ssTx << psbtx;
85
    // parse ExternalSigner master fingerprint
86
3
    std::vector<unsigned char> parsed_m_fingerprint = ParseHex(m_fingerprint);
87
    // Check if signer fingerprint matches any input master key fingerprint
88
3
    auto matches_signer_fingerprint = [&](const PSBTInput& input) {
89
3
        for (const auto& entry : input.hd_keypaths) {
90
0
            if (std::ranges::equal(parsed_m_fingerprint, entry.second.fingerprint)) return true;
91
0
        }
92
3
        for (const auto& entry : input.m_tap_bip32_paths) {
93
3
            if (std::ranges::equal(parsed_m_fingerprint, entry.second.second.fingerprint)) return true;
94
3
        }
95
0
        return false;
96
3
    };
97
98
3
    if (!std::any_of(psbtx.inputs.begin(), psbtx.inputs.end(), matches_signer_fingerprint)) {
99
0
        error = "Signer fingerprint " + m_fingerprint + " does not match any of the inputs:\n" + EncodeBase64(ssTx.str());
100
0
        return false;
101
0
    }
102
103
3
    const std::vector<std::string> command = Cat(m_command, Cat({"--stdin", "--fingerprint", m_fingerprint}, NetworkArg()));
104
3
    const std::string stdinStr = "signtx " + EncodeBase64(ssTx.str());
105
106
3
    const UniValue signer_result = RunCommandParseJSON(command, stdinStr);
107
108
3
    if (signer_result.find_value("error").isStr()) {
109
0
        error = signer_result.find_value("error").get_str();
110
0
        return false;
111
0
    }
112
113
3
    if (!signer_result.find_value("psbt").isStr()) {
114
0
        error = "Unexpected result from signer";
115
0
        return false;
116
0
    }
117
118
3
    util::Result<PartiallySignedTransaction> signer_psbtx = DecodeBase64PSBT(signer_result.find_value("psbt").get_str());
119
3
    if (!signer_psbtx) {
120
0
        error = strprintf("TX decode failed %s", util::ErrorString(signer_psbtx).original);
121
0
        return false;
122
0
    }
123
124
3
    psbtx = *signer_psbtx;
125
126
3
    return true;
127
3
}