1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef BITCOIN_KEYSTORE_H
6 #define BITCOIN_KEYSTORE_H
10 #include <boost/signals2/signal.hpp>
11 #include <boost/variant.hpp>
15 class CNoDestination {
17 friend bool operator==(const CNoDestination &a, const CNoDestination &b) { return true; }
18 friend bool operator<(const CNoDestination &a, const CNoDestination &b) { return true; }
21 /** A txout script template with a specific destination. It is either:
22 * CNoDestination: no destination set
23 * CKeyID: TX_PUBKEYHASH destination
24 * CScriptID: TX_SCRIPTHASH destination
26 * A CTxDestination is the internal data type encoded in a CBitcoinAddress.
28 typedef boost::variant<CNoDestination, CKeyID, CScriptID> CTxDestination;
30 /** A virtual base class for key stores */
34 mutable CCriticalSection cs_KeyStore;
37 virtual ~CKeyStore() {}
39 // Add a key to the store.
40 virtual bool AddKey(const CKey& key) =0;
42 // Check whether a key corresponding to a given address is present in the store.
43 virtual bool HaveKey(const CKeyID &address) const =0;
44 virtual bool GetKey(const CKeyID &address, CKey& keyOut) const =0;
45 virtual void GetKeys(std::set<CKeyID> &setAddress) const =0;
46 virtual bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
48 // Support for BIP 0013 : see https://en.bitcoin.it/wiki/BIP_0013
49 virtual bool AddCScript(const CScript& redeemScript) =0;
50 virtual bool HaveCScript(const CScriptID &hash) const =0;
51 virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const =0;
53 // Support for Watch-only addresses
54 virtual bool AddWatchOnly(const CScript &dest) =0;
55 virtual bool RemoveWatchOnly(const CScript &dest) =0;
56 virtual bool HaveWatchOnly(const CScript &dest) const =0;
57 virtual bool HaveWatchOnly() const =0;
59 virtual bool GetSecret(const CKeyID &address, CSecret& vchSecret, bool &fCompressed) const
62 if (!GetKey(address, key))
64 vchSecret = key.GetSecret(fCompressed);
68 virtual bool CheckOwnership(const CPubKey &pubKeyVariant, const CPubKey &R) const =0;
69 virtual bool CreatePrivKey(const CPubKey &pubKeyVariant, const CPubKey &R, CKey &privKey) const =0;
70 virtual void ListMalleablePubKeys(std::list<CMalleablePubKey> &malleablePubKeyList) const =0;
73 typedef std::map<CKeyID, std::pair<CSecret, bool> > KeyMap;
74 typedef std::map<CScriptID, CScript > ScriptMap;
75 typedef std::set<CScript> WatchOnlySet;
76 typedef std::map<CMalleableKeyView, CMalleableKey> MalleableKeyMap;
78 /** Basic key store, that keeps keys in an address->secret map */
79 class CBasicKeyStore : public CKeyStore
83 MalleableKeyMap mapMalleableKeys;
86 WatchOnlySet setWatchOnly;
89 bool AddKey(const CKey& key);
90 bool HaveKey(const CKeyID &address) const
95 result = (mapKeys.count(address) > 0);
99 void GetKeys(std::set<CKeyID> &setAddress) const
104 KeyMap::const_iterator mi = mapKeys.begin();
105 while (mi != mapKeys.end())
107 setAddress.insert((*mi).first);
112 bool GetKey(const CKeyID &address, CKey &keyOut) const
116 KeyMap::const_iterator mi = mapKeys.find(address);
117 if (mi != mapKeys.end())
120 keyOut.SetSecret((*mi).second.first, (*mi).second.second);
126 virtual bool AddCScript(const CScript& redeemScript);
127 virtual bool HaveCScript(const CScriptID &hash) const;
128 virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const;
130 virtual bool AddWatchOnly(const CScript &dest);
131 virtual bool RemoveWatchOnly(const CScript &dest);
132 virtual bool HaveWatchOnly(const CScript &dest) const;
133 virtual bool HaveWatchOnly() const;
135 bool CheckOwnership(const CPubKey &pubKeyVariant, const CPubKey &R) const
139 for (MalleableKeyMap::const_iterator mi = mapMalleableKeys.begin(); mi != mapMalleableKeys.end(); mi++)
141 if (mi->first.CheckKeyVariant(R, pubKeyVariant))
148 bool CreatePrivKey(const CPubKey &pubKeyVariant, const CPubKey &R, CKey &privKey) const
152 for (MalleableKeyMap::const_iterator mi = mapMalleableKeys.begin(); mi != mapMalleableKeys.end(); mi++)
154 if (mi->second.CheckKeyVariant(R, pubKeyVariant, privKey))
161 void ListMalleablePubKeys(std::list<CMalleablePubKey> &malleablePubKeyList) const
163 malleablePubKeyList.clear();
167 for (MalleableKeyMap::const_iterator mi = mapMalleableKeys.begin(); mi != mapMalleableKeys.end(); mi++)
168 malleablePubKeyList.push_back(mi->first.GetMalleablePubKey());
173 typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
175 /** Keystore which keeps the private keys encrypted.
176 * It derives from the basic key store, which is used if no encryption is active.
178 class CCryptoKeyStore : public CBasicKeyStore
181 CryptedKeyMap mapCryptedKeys;
183 CKeyingMaterial vMasterKey;
185 // if fUseCrypto is true, mapKeys must be empty
186 // if fUseCrypto is false, vMasterKey must be empty
192 // will encrypt previously unencrypted keys
193 bool EncryptKeys(CKeyingMaterial& vMasterKeyIn);
194 bool DecryptKeys(const CKeyingMaterial& vMasterKeyIn);
196 bool Unlock(const CKeyingMaterial& vMasterKeyIn);
201 bool IsCrypted() const
206 bool IsLocked() const
213 result = vMasterKey.empty();
220 virtual bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
221 bool AddKey(const CKey& key);
222 bool HaveKey(const CKeyID &address) const
227 return CBasicKeyStore::HaveKey(address);
228 return mapCryptedKeys.count(address) > 0;
231 bool GetKey(const CKeyID &address, CKey& keyOut) const;
232 bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
233 void GetKeys(std::set<CKeyID> &setAddress) const
237 CBasicKeyStore::GetKeys(setAddress);
241 CryptedKeyMap::const_iterator mi = mapCryptedKeys.begin();
242 while (mi != mapCryptedKeys.end())
244 setAddress.insert((*mi).first);
249 /* Wallet status (encrypted, locked) changed.
250 * Note: Called without locks held.
252 boost::signals2::signal<void (CCryptoKeyStore* wallet)> NotifyStatusChanged;