Bitcoin Core 22.99.0
P2P Digital Currency
message.h
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-2020 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#ifndef BITCOIN_UTIL_MESSAGE_H
7#define BITCOIN_UTIL_MESSAGE_H
8
9#include <key.h> // For CKey
10#include <uint256.h>
11
12#include <string>
13
14extern const std::string MESSAGE_MAGIC;
15
25
28
31
34
37
39 OK
40};
41
42enum class SigningResult {
43 OK,
46};
47
54 const std::string& address,
55 const std::string& signature,
56 const std::string& message);
57
63bool MessageSign(
64 const CKey& privkey,
65 const std::string& message,
66 std::string& signature);
67
72uint256 MessageHash(const std::string& message);
73
74std::string SigningResultString(const SigningResult res);
75
76#endif // BITCOIN_UTIL_MESSAGE_H
An encapsulated private key.
Definition: key.h:27
256-bit opaque blob.
Definition: uint256.h:124
uint256 MessageHash(const std::string &message)
Hashes a message for signing and verification in a manner that prevents inadvertently signing a trans...
Definition: message.cpp:72
SigningResult
Definition: message.h:42
@ PRIVATE_KEY_NOT_AVAILABLE
@ OK
No error.
MessageVerificationResult
The result of a signed message verification.
Definition: message.h:22
@ ERR_MALFORMED_SIGNATURE
The provided signature couldn't be parsed (maybe invalid base64).
@ ERR_INVALID_ADDRESS
The provided address is invalid.
@ ERR_ADDRESS_NO_KEY
The provided address is valid but does not refer to a public key.
@ ERR_NOT_SIGNED
The message was not signed with the private key of the provided address.
@ OK
The message verification was successful.
@ ERR_PUBKEY_NOT_RECOVERED
A public key could not be recovered from the provided signature and message.
bool MessageSign(const CKey &privkey, const std::string &message, std::string &signature)
Sign a message.
Definition: message.cpp:56
const std::string MESSAGE_MAGIC
Text used to signify that a signed message follows and to prevent inadvertently signing a transaction...
Definition: message.cpp:22
std::string SigningResultString(const SigningResult res)
Definition: message.cpp:80
MessageVerificationResult MessageVerify(const std::string &address, const std::string &signature, const std::string &message)
Verify a signed message.
Definition: message.cpp:24