Coverage Report

Created: 2025-09-19 18:31

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/root/bitcoin/src/rpc/signmessage.cpp
Line
Count
Source
1
// Copyright (c) 2010 Satoshi Nakamoto
2
// Copyright (c) 2009-2022 The Bitcoin Core developers
3
// Distributed under the MIT software license, see the accompanying
4
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6
#include <common/signmessage.h>
7
#include <key.h>
8
#include <key_io.h>
9
#include <rpc/protocol.h>
10
#include <rpc/request.h>
11
#include <rpc/server.h>
12
#include <rpc/util.h>
13
#include <univalue.h>
14
15
#include <string>
16
17
static RPCHelpMan verifymessage()
18
0
{
19
0
    return RPCHelpMan{"verifymessage",
20
0
        "Verify a signed message.",
21
0
        {
22
0
            {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to use for the signature."},
23
0
            {"signature", RPCArg::Type::STR, RPCArg::Optional::NO, "The signature provided by the signer in base 64 encoding (see signmessage)."},
24
0
            {"message", RPCArg::Type::STR, RPCArg::Optional::NO, "The message that was signed."},
25
0
        },
26
0
        RPCResult{
27
0
            RPCResult::Type::BOOL, "", "If the signature is verified or not."
28
0
        },
29
0
        RPCExamples{
30
0
            "\nUnlock the wallet for 30 seconds\n"
31
0
            + HelpExampleCli("walletpassphrase", "\"mypassphrase\" 30") +
32
0
            "\nCreate the signature\n"
33
0
            + HelpExampleCli("signmessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"my message\"") +
34
0
            "\nVerify the signature\n"
35
0
            + HelpExampleCli("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"signature\" \"my message\"") +
36
0
            "\nAs a JSON-RPC call\n"
37
0
            + HelpExampleRpc("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\", \"signature\", \"my message\"")
38
0
        },
39
0
        [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
40
0
        {
41
0
            std::string strAddress = self.Arg<std::string>("address");
42
0
            std::string strSign = self.Arg<std::string>("signature");
43
0
            std::string strMessage = self.Arg<std::string>("message");
44
45
0
            switch (MessageVerify(strAddress, strSign, strMessage)) {
46
0
            case MessageVerificationResult::ERR_INVALID_ADDRESS:
47
0
                throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid address");
48
0
            case MessageVerificationResult::ERR_ADDRESS_NO_KEY:
49
0
                throw JSONRPCError(RPC_TYPE_ERROR, "Address does not refer to key");
50
0
            case MessageVerificationResult::ERR_MALFORMED_SIGNATURE:
51
0
                throw JSONRPCError(RPC_TYPE_ERROR, "Malformed base64 encoding");
52
0
            case MessageVerificationResult::ERR_PUBKEY_NOT_RECOVERED:
53
0
            case MessageVerificationResult::ERR_NOT_SIGNED:
54
0
                return false;
55
0
            case MessageVerificationResult::OK:
56
0
                return true;
57
0
            }
58
59
0
            return false;
60
0
        },
61
0
    };
62
0
}
63
64
static RPCHelpMan signmessagewithprivkey()
65
0
{
66
0
    return RPCHelpMan{
67
0
        "signmessagewithprivkey",
68
0
        "Sign a message with the private key of an address\n",
69
0
        {
70
0
            {"privkey", RPCArg::Type::STR, RPCArg::Optional::NO, "The private key to sign the message with."},
71
0
            {"message", RPCArg::Type::STR, RPCArg::Optional::NO, "The message to create a signature of."},
72
0
        },
73
0
        RPCResult{
74
0
            RPCResult::Type::STR, "signature", "The signature of the message encoded in base 64"
75
0
        },
76
0
        RPCExamples{
77
0
            "\nCreate the signature\n"
78
0
            + HelpExampleCli("signmessagewithprivkey", "\"privkey\" \"my message\"") +
79
0
            "\nVerify the signature\n"
80
0
            + HelpExampleCli("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"signature\" \"my message\"") +
81
0
            "\nAs a JSON-RPC call\n"
82
0
            + HelpExampleRpc("signmessagewithprivkey", "\"privkey\", \"my message\"")
83
0
        },
84
0
        [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
85
0
        {
86
0
            std::string strPrivkey = request.params[0].get_str();
87
0
            std::string strMessage = request.params[1].get_str();
88
89
0
            CKey key = DecodeSecret(strPrivkey);
90
0
            if (!key.IsValid()) {
91
0
                throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key");
92
0
            }
93
94
0
            std::string signature;
95
96
0
            if (!MessageSign(key, strMessage, signature)) {
97
0
                throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Sign failed");
98
0
            }
99
100
0
            return signature;
101
0
        },
102
0
    };
103
0
}
104
105
void RegisterSignMessageRPCCommands(CRPCTable& t)
106
0
{
107
0
    static const CRPCCommand commands[]{
108
0
        {"util", &verifymessage},
109
0
        {"util", &signmessagewithprivkey},
110
0
    };
111
0
    for (const auto& c : commands) {
112
0
        t.appendCommand(c.name, &c);
113
0
    }
114
0
}