Bitcoin Core  0.18.99
P2P Digital Currency
key.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2018 The Bitcoin Core developers
3 // Copyright (c) 2017 The Zcash developers
4 // Distributed under the MIT software license, see the accompanying
5 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
6 
7 #ifndef BITCOIN_KEY_H
8 #define BITCOIN_KEY_H
9 
10 #include <pubkey.h>
11 #include <serialize.h>
13 #include <uint256.h>
14 
15 #include <stdexcept>
16 #include <vector>
17 
18 
24 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CPrivKey;
25 
27 class CKey
28 {
29 public:
33  static const unsigned int PRIVATE_KEY_SIZE = 279;
34  static const unsigned int COMPRESSED_PRIVATE_KEY_SIZE = 214;
39  static_assert(
40  PRIVATE_KEY_SIZE >= COMPRESSED_PRIVATE_KEY_SIZE,
41  "COMPRESSED_PRIVATE_KEY_SIZE is larger than PRIVATE_KEY_SIZE");
42 
43 private:
46  bool fValid;
47 
50 
52  std::vector<unsigned char, secure_allocator<unsigned char> > keydata;
53 
55  bool static Check(const unsigned char* vch);
56 
57 public:
59  CKey() : fValid(false), fCompressed(false)
60  {
61  // Important: vch must be 32 bytes in length to not break serialization
62  keydata.resize(32);
63  }
64 
65  friend bool operator==(const CKey& a, const CKey& b)
66  {
67  return a.fCompressed == b.fCompressed &&
68  a.size() == b.size() &&
69  memcmp(a.keydata.data(), b.keydata.data(), a.size()) == 0;
70  }
71 
73  template <typename T>
74  void Set(const T pbegin, const T pend, bool fCompressedIn)
75  {
76  if (size_t(pend - pbegin) != keydata.size()) {
77  fValid = false;
78  } else if (Check(&pbegin[0])) {
79  memcpy(keydata.data(), (unsigned char*)&pbegin[0], keydata.size());
80  fValid = true;
81  fCompressed = fCompressedIn;
82  } else {
83  fValid = false;
84  }
85  }
86 
88  unsigned int size() const { return (fValid ? keydata.size() : 0); }
89  const unsigned char* begin() const { return keydata.data(); }
90  const unsigned char* end() const { return keydata.data() + size(); }
91 
93  bool IsValid() const { return fValid; }
94 
96  bool IsCompressed() const { return fCompressed; }
97 
99  void MakeNewKey(bool fCompressed);
100 
102  bool Negate();
103 
108  CPrivKey GetPrivKey() const;
109 
114  CPubKey GetPubKey() const;
115 
120  bool Sign(const uint256& hash, std::vector<unsigned char>& vchSig, bool grind = true, uint32_t test_case = 0) const;
121 
129  bool SignCompact(const uint256& hash, std::vector<unsigned char>& vchSig) const;
130 
132  bool Derive(CKey& keyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode& cc) const;
133 
138  bool VerifyPubKey(const CPubKey& vchPubKey) const;
139 
141  bool Load(const CPrivKey& privkey, const CPubKey& vchPubKey, bool fSkipCheck);
142 };
143 
144 struct CExtKey {
145  unsigned char nDepth;
146  unsigned char vchFingerprint[4];
147  unsigned int nChild;
150 
151  friend bool operator==(const CExtKey& a, const CExtKey& b)
152  {
153  return a.nDepth == b.nDepth &&
154  memcmp(&a.vchFingerprint[0], &b.vchFingerprint[0], sizeof(vchFingerprint)) == 0 &&
155  a.nChild == b.nChild &&
156  a.chaincode == b.chaincode &&
157  a.key == b.key;
158  }
159 
160  void Encode(unsigned char code[BIP32_EXTKEY_SIZE]) const;
161  void Decode(const unsigned char code[BIP32_EXTKEY_SIZE]);
162  bool Derive(CExtKey& out, unsigned int nChild) const;
163  CExtPubKey Neuter() const;
164  void SetSeed(const unsigned char* seed, unsigned int nSeedLen);
165  template <typename Stream>
166  void Serialize(Stream& s) const
167  {
168  unsigned int len = BIP32_EXTKEY_SIZE;
169  ::WriteCompactSize(s, len);
170  unsigned char code[BIP32_EXTKEY_SIZE];
171  Encode(code);
172  s.write((const char *)&code[0], len);
173  }
174  template <typename Stream>
175  void Unserialize(Stream& s)
176  {
177  unsigned int len = ::ReadCompactSize(s);
178  unsigned char code[BIP32_EXTKEY_SIZE];
179  if (len != BIP32_EXTKEY_SIZE)
180  throw std::runtime_error("Invalid extended key size\n");
181  s.read((char *)&code[0], len);
182  Decode(code);
183  }
184 };
185 
187 void ECC_Start();
188 
190 void ECC_Stop();
191 
193 bool ECC_InitSanityCheck();
194 
195 #endif // BITCOIN_KEY_H
CPrivKey GetPrivKey() const
Convert the private key to a CPrivKey (serialized OpenSSL private key data).
Definition: key.cpp:172
CKey key
Definition: key.h:149
bool Negate()
Negate private key.
Definition: key.cpp:166
void ECC_Stop()
Deinitialize the elliptic curve support.
Definition: key.cpp:366
uint64_t ReadCompactSize(Stream &is)
Definition: serialize.h:289
void WriteCompactSize(CSizeComputer &os, uint64_t nSize)
Definition: serialize.h:986
bool VerifyPubKey(const CPubKey &vchPubKey) const
Verify thoroughly whether a private key and a public key match.
Definition: key.cpp:233
CPubKey GetPubKey() const
Compute the public key from a private key.
Definition: key.cpp:185
static const unsigned int COMPRESSED_PRIVATE_KEY_SIZE
Definition: key.h:34
Definition: key.h:144
unsigned char vchFingerprint[4]
Definition: key.h:146
void Unserialize(Stream &s)
Definition: key.h:175
const unsigned char * begin() const
Definition: key.h:89
bool fValid
see www.keylength.com script supports up to 75 for single byte push
Definition: key.h:41
bool SignCompact(const uint256 &hash, std::vector< unsigned char > &vchSig) const
Create a compact signature (65 bytes), which allows reconstructing the used public key...
Definition: key.cpp:247
std::vector< unsigned char, secure_allocator< unsigned char > > CPrivKey
secure_allocator is defined in allocators.h CPrivKey is a serialized private key, with all parameters...
Definition: key.h:24
bool Sign(const uint256 &hash, std::vector< unsigned char > &vchSig, bool grind=true, uint32_t test_case=0) const
Create a DER-serialized signature.
Definition: key.cpp:211
static const unsigned int PRIVATE_KEY_SIZE
secp256k1:
Definition: key.h:33
unsigned char nDepth
Definition: key.h:145
friend bool operator==(const CExtKey &a, const CExtKey &b)
Definition: key.h:151
An encapsulated public key.
Definition: pubkey.h:30
void MakeNewKey(bool fCompressed)
Generate a new private key using a cryptographic PRNG.
Definition: key.cpp:158
unsigned int nChild
Definition: key.h:147
unsigned int size() const
Simple read-only vector-like interface.
Definition: key.h:88
bool IsCompressed() const
Check whether the public key corresponding to this private key is (to be) compressed.
Definition: key.h:96
ChainCode chaincode
Definition: key.h:148
void Set(const T pbegin, const T pend, bool fCompressedIn)
Initialize using begin and end iterators to byte data.
Definition: key.h:74
std::pair< std::string, data > Decode(const std::string &str)
Decode a Bech32 string.
Definition: bech32.cpp:159
256-bit opaque blob.
Definition: uint256.h:121
bool Derive(CKey &keyChild, ChainCode &ccChild, unsigned int nChild, const ChainCode &cc) const
Derive BIP32 child key.
Definition: key.cpp:274
void * memcpy(void *a, const void *b, size_t c)
const unsigned char * end() const
Definition: key.h:90
const unsigned int BIP32_EXTKEY_SIZE
Definition: pubkey.h:17
bool fCompressed
Whether the public key corresponding to this private key is (to be) compressed.
Definition: key.h:49
bool ECC_InitSanityCheck()
Check that required EC support is available at runtime.
Definition: key.cpp:342
CKey()
Construct an invalid private key.
Definition: key.h:59
std::vector< unsigned char, secure_allocator< unsigned char > > keydata
The actual byte data.
Definition: key.h:52
static bool Check(const unsigned char *vch)
Check whether the 32-byte array pointed to by vch is valid keydata.
Definition: key.cpp:154
An encapsulated private key.
Definition: key.h:27
std::string Encode(const std::string &hrp, const data &values)
Encode a Bech32 string.
Definition: bech32.cpp:147
void Serialize(Stream &s) const
Definition: key.h:166
bool Load(const CPrivKey &privkey, const CPubKey &vchPubKey, bool fSkipCheck)
Load private key and check that public key matches.
Definition: key.cpp:262
friend bool operator==(const CKey &a, const CKey &b)
Definition: key.h:65
bool IsValid() const
Check whether this private key is valid.
Definition: key.h:93
void ECC_Start()
Initialize the elliptic curve support.
Definition: key.cpp:349