LCOV - code coverage report
Current view: top level - src - external_signer.cpp (source / functions) Coverage Total Hit
Test: total_coverage.info Lines: 85.0 % 60 51
Test Date: 2024-11-04 05:10:19 Functions: 100.0 % 7 7
Branches: 42.3 % 156 66

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

Generated by: LCOV version 2.0-1