Bitcoin Core  0.18.99
P2P Digital Currency
crypter.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2018 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 #ifndef BITCOIN_WALLET_CRYPTER_H
6 #define BITCOIN_WALLET_CRYPTER_H
7 
8 #include <keystore.h>
9 #include <serialize.h>
11 
12 #include <atomic>
13 
14 const unsigned int WALLET_CRYPTO_KEY_SIZE = 32;
15 const unsigned int WALLET_CRYPTO_SALT_SIZE = 8;
16 const unsigned int WALLET_CRYPTO_IV_SIZE = 16;
17 
35 {
36 public:
37  std::vector<unsigned char> vchCryptedKey;
38  std::vector<unsigned char> vchSalt;
41  unsigned int nDerivationMethod;
42  unsigned int nDeriveIterations;
45  std::vector<unsigned char> vchOtherDerivationParameters;
46 
48 
49  template <typename Stream, typename Operation>
50  inline void SerializationOp(Stream& s, Operation ser_action) {
51  READWRITE(vchCryptedKey);
52  READWRITE(vchSalt);
53  READWRITE(nDerivationMethod);
54  READWRITE(nDeriveIterations);
55  READWRITE(vchOtherDerivationParameters);
56  }
57 
59  {
60  // 25000 rounds is just under 0.1 seconds on a 1.86 GHz Pentium M
61  // ie slightly lower than the lowest hardware we need bother supporting
62  nDeriveIterations = 25000;
63  nDerivationMethod = 0;
64  vchOtherDerivationParameters = std::vector<unsigned char>(0);
65  }
66 };
67 
68 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CKeyingMaterial;
69 
71 {
72  class TestCrypter;
73 }
74 
76 class CCrypter
77 {
78 friend class wallet_crypto_tests::TestCrypter; // for test access to chKey/chIV
79 private:
80  std::vector<unsigned char, secure_allocator<unsigned char>> vchKey;
81  std::vector<unsigned char, secure_allocator<unsigned char>> vchIV;
82  bool fKeySet;
83 
84  int BytesToKeySHA512AES(const std::vector<unsigned char>& chSalt, const SecureString& strKeyData, int count, unsigned char *key,unsigned char *iv) const;
85 
86 public:
87  bool SetKeyFromPassphrase(const SecureString &strKeyData, const std::vector<unsigned char>& chSalt, const unsigned int nRounds, const unsigned int nDerivationMethod);
88  bool Encrypt(const CKeyingMaterial& vchPlaintext, std::vector<unsigned char> &vchCiphertext) const;
89  bool Decrypt(const std::vector<unsigned char>& vchCiphertext, CKeyingMaterial& vchPlaintext) const;
90  bool SetKey(const CKeyingMaterial& chNewKey, const std::vector<unsigned char>& chNewIV);
91 
92  void CleanKey()
93  {
94  memory_cleanse(vchKey.data(), vchKey.size());
95  memory_cleanse(vchIV.data(), vchIV.size());
96  fKeySet = false;
97  }
98 
100  {
101  fKeySet = false;
102  vchKey.resize(WALLET_CRYPTO_KEY_SIZE);
103  vchIV.resize(WALLET_CRYPTO_IV_SIZE);
104  }
105 
107  {
108  CleanKey();
109  }
110 };
111 
116 {
117 private:
118 
119  CKeyingMaterial vMasterKey GUARDED_BY(cs_KeyStore);
120 
123  std::atomic<bool> fUseCrypto;
124 
127 
128 protected:
129  using CryptedKeyMap = std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char>>>;
130 
131  bool SetCrypted();
132 
134  bool EncryptKeys(CKeyingMaterial& vMasterKeyIn);
135 
136  bool Unlock(const CKeyingMaterial& vMasterKeyIn, bool accept_no_keys = false);
137  CryptedKeyMap mapCryptedKeys GUARDED_BY(cs_KeyStore);
138 
139 public:
140  CCryptoKeyStore() : fUseCrypto(false), fDecryptionThoroughlyChecked(false)
141  {
142  }
143 
144  bool IsCrypted() const { return fUseCrypto; }
145  bool IsLocked() const;
146  bool Lock();
147 
148  virtual bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
149  bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey) override;
150  bool HaveKey(const CKeyID &address) const override;
151  bool GetKey(const CKeyID &address, CKey& keyOut) const override;
152  bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
153  std::set<CKeyID> GetKeys() const override;
154 
159  boost::signals2::signal<void (CCryptoKeyStore* wallet)> NotifyStatusChanged;
160 };
161 
162 #endif // BITCOIN_WALLET_CRYPTER_H
unsigned int nDerivationMethod
0 = EVP_sha512() 1 = scrypt()
Definition: crypter.h:41
const unsigned int WALLET_CRYPTO_KEY_SIZE
Definition: crypter.h:14
bool HaveKey(const CKeyStore &store, const CKey &key)
Checks if a CKey is in the given CKeyStore compressed or otherwise.
Definition: keystore.cpp:200
Encryption/decryption context with key information.
Definition: crypter.h:76
bool IsCrypted() const
Definition: crypter.h:144
std::vector< unsigned char > vchCryptedKey
Definition: crypter.h:37
Private key encryption is done based on a CMasterKey, which holds a salt and random encryption key...
Definition: crypter.h:34
std::basic_string< char, std::char_traits< char >, secure_allocator< char > > SecureString
Definition: secure.h:60
std::vector< unsigned char > vchOtherDerivationParameters
Use this for more parameters to key derivation, such as the various parameters to scrypt...
Definition: crypter.h:45
std::vector< unsigned char, secure_allocator< unsigned char > > CKeyingMaterial
Definition: crypter.h:68
void CleanKey()
Definition: crypter.h:92
std::atomic< bool > fUseCrypto
if fUseCrypto is true, mapKeys must be empty if fUseCrypto is false, vMasterKey must be empty ...
Definition: crypter.h:123
const unsigned int WALLET_CRYPTO_IV_SIZE
Definition: crypter.h:16
Keystore which keeps the private keys encrypted.
Definition: crypter.h:115
std::map< CKeyID, std::pair< CPubKey, std::vector< unsigned char > >> CryptedKeyMap
Definition: crypter.h:129
CCrypter()
Definition: crypter.h:99
boost::signals2::signal< void(CCryptoKeyStore *wallet)> NotifyStatusChanged
Wallet status (encrypted, locked) changed.
Definition: crypter.h:159
void memory_cleanse(void *ptr, size_t len)
Definition: cleanse.cpp:31
std::vector< unsigned char, secure_allocator< unsigned char > > vchKey
Definition: crypter.h:80
std::vector< unsigned char, secure_allocator< unsigned char > > vchIV
Definition: crypter.h:81
bool fKeySet
Definition: crypter.h:82
An encapsulated public key.
Definition: pubkey.h:30
ADD_SERIALIZE_METHODS
Definition: crypter.h:47
CMasterKey()
Definition: crypter.h:58
const unsigned int WALLET_CRYPTO_SALT_SIZE
Definition: crypter.h:15
void SerializationOp(Stream &s, Operation ser_action)
Definition: crypter.h:50
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:20
~CCrypter()
Definition: crypter.h:106
std::vector< unsigned char > vchSalt
Definition: crypter.h:38
#define GUARDED_BY(x)
Definition: threadsafety.h:38
An encapsulated private key.
Definition: key.h:27
unsigned int nDeriveIterations
Definition: crypter.h:42
#define READWRITE(...)
Definition: serialize.h:184
bool fDecryptionThoroughlyChecked
keeps track of whether Unlock has run a thorough check before
Definition: crypter.h:126
Basic key store, that keeps keys in an address->secret map.
Definition: keystore.h:42