Branch data Line data Source code
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 : 88 : static RPCHelpMan verifymessage()
18 : : {
19 : 88 : return RPCHelpMan{"verifymessage",
20 [ + - ]: 176 : "Verify a signed message.",
21 : : {
22 [ + - + - ]: 176 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address to use for the signature."},
23 [ + - + - ]: 176 : {"signature", RPCArg::Type::STR, RPCArg::Optional::NO, "The signature provided by the signer in base 64 encoding (see signmessage)."},
24 [ + - + - ]: 176 : {"message", RPCArg::Type::STR, RPCArg::Optional::NO, "The message that was signed."},
25 : : },
26 [ + - ]: 176 : RPCResult{
27 [ + - + - ]: 176 : RPCResult::Type::BOOL, "", "If the signature is verified or not."
28 [ + - ]: 176 : },
29 : 88 : RPCExamples{
30 : : "\nUnlock the wallet for 30 seconds\n"
31 [ + - + - : 176 : + HelpExampleCli("walletpassphrase", "\"mypassphrase\" 30") +
+ - + - ]
32 : 88 : "\nCreate the signature\n"
33 [ + - + - : 352 : + HelpExampleCli("signmessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"my message\"") +
+ - + - ]
34 : 88 : "\nVerify the signature\n"
35 [ + - + - : 352 : + HelpExampleCli("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"signature\" \"my message\"") +
+ - + - ]
36 : 88 : "\nAs a JSON-RPC call\n"
37 [ + - + - : 352 : + HelpExampleRpc("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\", \"signature\", \"my message\"")
+ - + - ]
38 [ + - ]: 88 : },
39 : 88 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
40 : : {
41 [ # # # # : 0 : switch (MessageVerify(std::string{self.Arg<std::string_view>("address")},
# # ]
42 [ # # # # ]: 0 : std::string{self.Arg<std::string_view>("signature")},
43 [ # # # # : 0 : std::string{self.Arg<std::string_view>("message")})) {
# # ]
44 : 0 : case MessageVerificationResult::ERR_INVALID_ADDRESS:
45 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid address");
46 : 0 : case MessageVerificationResult::ERR_ADDRESS_NO_KEY:
47 [ # # # # ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, "Address does not refer to key");
48 : 0 : case MessageVerificationResult::ERR_MALFORMED_SIGNATURE:
49 [ # # # # ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, "Malformed base64 encoding");
50 : 0 : case MessageVerificationResult::ERR_PUBKEY_NOT_RECOVERED:
51 : 0 : case MessageVerificationResult::ERR_NOT_SIGNED:
52 : 0 : return false;
53 : 0 : case MessageVerificationResult::OK:
54 : 0 : return true;
55 : : }
56 : :
57 : 0 : return false;
58 : : },
59 [ + - + - : 616 : };
+ + - - ]
60 [ + - + - : 528 : }
+ - - - ]
61 : :
62 : 88 : static RPCHelpMan signmessagewithprivkey()
63 : : {
64 : 88 : return RPCHelpMan{
65 : 88 : "signmessagewithprivkey",
66 [ + - ]: 176 : "Sign a message with the private key of an address\n",
67 : : {
68 [ + - + - ]: 176 : {"privkey", RPCArg::Type::STR, RPCArg::Optional::NO, "The private key to sign the message with."},
69 [ + - + - ]: 176 : {"message", RPCArg::Type::STR, RPCArg::Optional::NO, "The message to create a signature of."},
70 : : },
71 [ + - ]: 176 : RPCResult{
72 [ + - + - ]: 176 : RPCResult::Type::STR, "signature", "The signature of the message encoded in base 64"
73 [ + - ]: 176 : },
74 : 88 : RPCExamples{
75 : : "\nCreate the signature\n"
76 [ + - + - : 176 : + HelpExampleCli("signmessagewithprivkey", "\"privkey\" \"my message\"") +
+ - + - ]
77 : 88 : "\nVerify the signature\n"
78 [ + - + - : 352 : + HelpExampleCli("verifymessage", "\"1D1ZrZNe3JUo7ZycKEYQQiQAWd9y54F4XX\" \"signature\" \"my message\"") +
+ - + - ]
79 : 88 : "\nAs a JSON-RPC call\n"
80 [ + - + - : 352 : + HelpExampleRpc("signmessagewithprivkey", "\"privkey\", \"my message\"")
+ - + - ]
81 [ + - ]: 88 : },
82 : 88 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
83 : : {
84 [ # # ]: 0 : std::string strPrivkey = request.params[0].get_str();
85 [ # # # # : 0 : std::string strMessage = request.params[1].get_str();
# # ]
86 : :
87 [ # # ]: 0 : CKey key = DecodeSecret(strPrivkey);
88 [ # # ]: 0 : if (!key.IsValid()) {
89 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key");
90 : : }
91 : :
92 [ # # ]: 0 : std::string signature;
93 : :
94 [ # # # # ]: 0 : if (!MessageSign(key, strMessage, signature)) {
95 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Sign failed");
96 : : }
97 : :
98 [ # # ]: 0 : return signature;
99 : 0 : },
100 [ + - + - : 528 : };
+ + - - ]
101 [ + - + - : 352 : }
- - ]
102 : :
103 : 176 : void RegisterSignMessageRPCCommands(CRPCTable& t)
104 : : {
105 : 176 : static const CRPCCommand commands[]{
106 [ + - ]: 88 : {"util", &verifymessage},
107 [ + - ]: 88 : {"util", &signmessagewithprivkey},
108 [ + + + - : 264 : };
+ - + - -
- ]
109 [ + + ]: 528 : for (const auto& c : commands) {
110 : 352 : t.appendCommand(c.name, &c);
111 : : }
112 : 176 : }
|
