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);
69 typedef std::map<CKeyID, std::pair<CSecret, bool> > KeyMap;
70 typedef std::map<CScriptID, CScript > ScriptMap;
71 typedef std::set<CScript> WatchOnlySet;
73 /** Basic key store, that keeps keys in an address->secret map */
74 class CBasicKeyStore : public CKeyStore
79 WatchOnlySet setWatchOnly;
82 bool AddKey(const CKey& key);
83 bool HaveKey(const CKeyID &address) const
88 result = (mapKeys.count(address) > 0);
92 void GetKeys(std::set<CKeyID> &setAddress) const
97 KeyMap::const_iterator mi = mapKeys.begin();
98 while (mi != mapKeys.end())
100 setAddress.insert((*mi).first);
105 bool GetKey(const CKeyID &address, CKey &keyOut) const
109 KeyMap::const_iterator mi = mapKeys.find(address);
110 if (mi != mapKeys.end())
113 keyOut.SetSecret((*mi).second.first, (*mi).second.second);
119 virtual bool AddCScript(const CScript& redeemScript);
120 virtual bool HaveCScript(const CScriptID &hash) const;
121 virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const;
123 virtual bool AddWatchOnly(const CScript &dest);
124 virtual bool RemoveWatchOnly(const CScript &dest);
125 virtual bool HaveWatchOnly(const CScript &dest) const;
126 virtual bool HaveWatchOnly() const;
129 typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
131 /** Keystore which keeps the private keys encrypted.
132 * It derives from the basic key store, which is used if no encryption is active.
134 class CCryptoKeyStore : public CBasicKeyStore
137 CryptedKeyMap mapCryptedKeys;
139 CKeyingMaterial vMasterKey;
141 // if fUseCrypto is true, mapKeys must be empty
142 // if fUseCrypto is false, vMasterKey must be empty
148 // will encrypt previously unencrypted keys
149 bool EncryptKeys(CKeyingMaterial& vMasterKeyIn);
151 bool Unlock(const CKeyingMaterial& vMasterKeyIn);
154 CCryptoKeyStore() : fUseCrypto(false)
158 bool IsCrypted() const
163 bool IsLocked() const
170 result = vMasterKey.empty();
177 virtual bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
178 bool AddKey(const CKey& key);
179 bool HaveKey(const CKeyID &address) const
184 return CBasicKeyStore::HaveKey(address);
185 return mapCryptedKeys.count(address) > 0;
189 bool GetKey(const CKeyID &address, CKey& keyOut) const;
190 bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
191 void GetKeys(std::set<CKeyID> &setAddress) const
195 CBasicKeyStore::GetKeys(setAddress);
199 CryptedKeyMap::const_iterator mi = mapCryptedKeys.begin();
200 while (mi != mapCryptedKeys.end())
202 setAddress.insert((*mi).first);
207 /* Wallet status (encrypted, locked) changed.
208 * Note: Called without locks held.
210 boost::signals2::signal<void (CCryptoKeyStore* wallet)> NotifyStatusChanged;