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;
72 typedef std::map<CKeyID, std::pair<CSecret, bool> > KeyMap;
73 typedef std::map<CScriptID, CScript > ScriptMap;
74 typedef std::set<CScript> WatchOnlySet;
75 typedef std::pair<CMalleableKeyView, CMalleableKey> MalleableKeyPair;
77 /** Basic key store, that keeps keys in an address->secret map */
78 class CBasicKeyStore : public CKeyStore
83 WatchOnlySet setWatchOnly;
84 MalleableKeyPair malleableKeyPair;
87 bool AddKey(const CKey& key);
88 bool HaveKey(const CKeyID &address) const
93 result = (mapKeys.count(address) > 0);
97 void GetKeys(std::set<CKeyID> &setAddress) const
102 KeyMap::const_iterator mi = mapKeys.begin();
103 while (mi != mapKeys.end())
105 setAddress.insert((*mi).first);
110 bool GetKey(const CKeyID &address, CKey &keyOut) const
114 KeyMap::const_iterator mi = mapKeys.find(address);
115 if (mi != mapKeys.end())
118 keyOut.SetSecret((*mi).second.first, (*mi).second.second);
124 virtual bool AddCScript(const CScript& redeemScript);
125 virtual bool HaveCScript(const CScriptID &hash) const;
126 virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const;
128 virtual bool AddWatchOnly(const CScript &dest);
129 virtual bool RemoveWatchOnly(const CScript &dest);
130 virtual bool HaveWatchOnly(const CScript &dest) const;
131 virtual bool HaveWatchOnly() const;
133 bool CheckOwnership(const CPubKey &pubKeyVariant, const CPubKey &R) const
138 result = const_cast<CBasicKeyStore*>(this)->malleableKeyPair.first.CheckKeyVariant(R, pubKeyVariant);
143 bool CreatePrivKey(const CPubKey &pubKeyVariant, const CPubKey &R, CKey &privKey) const
148 result = const_cast<CBasicKeyStore*>(this)->malleableKeyPair.second.CheckKeyVariant(R, pubKeyVariant, privKey);
154 typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
156 /** Keystore which keeps the private keys encrypted.
157 * It derives from the basic key store, which is used if no encryption is active.
159 class CCryptoKeyStore : public CBasicKeyStore
162 CryptedKeyMap mapCryptedKeys;
164 CKeyingMaterial vMasterKey;
166 // if fUseCrypto is true, mapKeys must be empty
167 // if fUseCrypto is false, vMasterKey must be empty
173 // will encrypt previously unencrypted keys
174 bool EncryptKeys(CKeyingMaterial& vMasterKeyIn);
175 bool DecryptKeys(const CKeyingMaterial& vMasterKeyIn);
177 bool Unlock(const CKeyingMaterial& vMasterKeyIn);
182 bool IsCrypted() const
187 bool IsLocked() const
194 result = vMasterKey.empty();
201 virtual bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
202 bool AddKey(const CKey& key);
203 bool HaveKey(const CKeyID &address) const
208 return CBasicKeyStore::HaveKey(address);
209 return mapCryptedKeys.count(address) > 0;
212 bool GetKey(const CKeyID &address, CKey& keyOut) const;
213 bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
214 void GetKeys(std::set<CKeyID> &setAddress) const
218 CBasicKeyStore::GetKeys(setAddress);
222 CryptedKeyMap::const_iterator mi = mapCryptedKeys.begin();
223 while (mi != mapCryptedKeys.end())
225 setAddress.insert((*mi).first);
230 /* Wallet status (encrypted, locked) changed.
231 * Note: Called without locks held.
233 boost::signals2::signal<void (CCryptoKeyStore* wallet)> NotifyStatusChanged;