src/keystore.h

   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
   7
   8 #include "crypter.h"
   9 #include "sync.h"
  10 #include <boost/signals2/signal.hpp>
  11 #include <boost/variant.hpp>
  12
  13 class CScript;
  14
  15 class CNoDestination {
  16 public:
  17     friend bool operator==(const CNoDestination &a, const CNoDestination &b) { return true; }
  18     friend bool operator<(const CNoDestination &a, const CNoDestination &b) { return true; }
  19 };
  20
  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
  25   *
  26   * A CTxDestination is the internal data type encoded in a CBitcoinAddress.
  27   */
  28 typedef boost::variant<CNoDestination, CKeyID, CScriptID> CTxDestination;
  29
  30 /** A virtual base class for key stores */
  31 class CKeyStore
  32 {
  33 protected:
  34     mutable CCriticalSection cs_KeyStore;
  35
  36 public:
  37     virtual ~CKeyStore() {}
  38
  39     // Add a key to the store.
  40     virtual bool AddKey(const CKey& key) =0;
  41
  42     // Add a malleable key to store.
  43     virtual bool AddMalleableKey(const CMalleableKey& mKey) =0;
  44     virtual bool GetMalleableKey(const CMalleableKeyView &keyView, CMalleableKey &mKey) const =0;
  45
  46     // Check whether a key corresponding to a given address is present in the store.
  47     virtual bool HaveKey(const CKeyID &address) const =0;
  48     virtual bool GetKey(const CKeyID &address, CKey& keyOut) const =0;
  49     virtual void GetKeys(std::set<CKeyID> &setAddress) const =0;
  50     virtual bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
  51
  52     // Support for BIP 0013 : see https://en.bitcoin.it/wiki/BIP_0013
  53     virtual bool AddCScript(const CScript& redeemScript) =0;
  54     virtual bool HaveCScript(const CScriptID &hash) const =0;
  55     virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const =0;
  56
  57     // Support for Watch-only addresses
  58     virtual bool AddWatchOnly(const CScript &dest) =0;
  59     virtual bool RemoveWatchOnly(const CScript &dest) =0;
  60     virtual bool HaveWatchOnly(const CScript &dest) const =0;
  61     virtual bool HaveWatchOnly() const =0;
  62
  63     virtual bool GetSecret(const CKeyID &address, CSecret& vchSecret, bool &fCompressed) const
  64     {
  65         CKey key;
  66         if (!GetKey(address, key))
  67             return false;
  68         vchSecret = key.GetSecret(fCompressed);
  69         return true;
  70     }
  71
  72     virtual bool CheckOwnership(const CPubKey &pubKeyVariant, const CPubKey &R) const =0;
  73     virtual bool CreatePrivKey(const CPubKey &pubKeyVariant, const CPubKey &R, CKey &privKey) const =0;
  74     virtual void ListMalleableViews(std::list<CMalleableKeyView> &malleableViewList) const =0;
  75 };
  76
  77 typedef std::map<CKeyID, std::pair<CSecret, bool> > KeyMap;
  78 typedef std::map<CScriptID, CScript > ScriptMap;
  79 typedef std::set<CScript> WatchOnlySet;
  80 typedef std::map<CMalleableKeyView, CMalleableKey> MalleableKeyMap;
  81
  82 /** Basic key store, that keeps keys in an address->secret map */
  83 class CBasicKeyStore : public CKeyStore
  84 {
  85 protected:
  86     KeyMap mapKeys;
  87     MalleableKeyMap mapMalleableKeys;
  88
  89     ScriptMap mapScripts;
  90     WatchOnlySet setWatchOnly;
  91
  92 public:
  93     bool AddKey(const CKey& key);
  94     bool AddMalleableKey(const CMalleableKey& mKey);
  95     bool GetMalleableKey(const CMalleableKeyView &keyView, CMalleableKey &mKey) const
  96     {
  97         {
  98             LOCK(cs_KeyStore);
  99             MalleableKeyMap::const_iterator mi = mapMalleableKeys.find(keyView);
 100             if (mi != mapMalleableKeys.end())
 101             {
 102                 mKey = mi->second;
 103                 return true;
 104             }
 105         }
 106         return false;
 107     }
 108
 109     bool HaveKey(const CKeyID &address) const
 110     {
 111         bool result;
 112         {
 113             LOCK(cs_KeyStore);
 114             result = (mapKeys.count(address) > 0);
 115         }
 116         return result;
 117     }
 118     void GetKeys(std::set<CKeyID> &setAddress) const
 119     {
 120         setAddress.clear();
 121         {
 122             LOCK(cs_KeyStore);
 123             KeyMap::const_iterator mi;
 124             for (mi = mapKeys.begin(); mi != mapKeys.end(); ++mi) setAddress.insert((*mi).first);
 125         }
 126     }
 127     bool GetKey(const CKeyID &address, CKey &keyOut) const
 128     {
 129         {
 130             LOCK(cs_KeyStore);
 131             KeyMap::const_iterator mi = mapKeys.find(address);
 132             if (mi != mapKeys.end())
 133             {
 134                 keyOut.Reset();
 135                 keyOut.SetSecret((*mi).second.first, (*mi).second.second);
 136                 return true;
 137             }
 138         }
 139         return false;
 140     }
 141     virtual bool AddCScript(const CScript& redeemScript);
 142     virtual bool HaveCScript(const CScriptID &hash) const;
 143     virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const;
 144
 145     virtual bool AddWatchOnly(const CScript &dest);
 146     virtual bool RemoveWatchOnly(const CScript &dest);
 147     virtual bool HaveWatchOnly(const CScript &dest) const;
 148     virtual bool HaveWatchOnly() const;
 149
 150     bool CheckOwnership(const CPubKey &pubKeyVariant, const CPubKey &R) const
 151     {
 152         {
 153             LOCK(cs_KeyStore);
 154             for (MalleableKeyMap::const_iterator mi = mapMalleableKeys.begin(); mi != mapMalleableKeys.end(); mi++)
 155             {
 156                 if (mi->first.CheckKeyVariant(R, pubKeyVariant))
 157                     return true;
 158             }
 159         }
 160         return false;
 161     }
 162
 163     bool CreatePrivKey(const CPubKey &pubKeyVariant, const CPubKey &R, CKey &privKey) const
 164     {
 165         {
 166             LOCK(cs_KeyStore);
 167             for (MalleableKeyMap::const_iterator mi = mapMalleableKeys.begin(); mi != mapMalleableKeys.end(); mi++)
 168             {
 169                 if (mi->second.CheckKeyVariant(R, pubKeyVariant, privKey))
 170                     return true;
 171             }
 172         }
 173         return false;
 174     }
 175
 176     void ListMalleableViews(std::list<CMalleableKeyView> &malleableViewList) const
 177     {
 178         malleableViewList.clear();
 179
 180         {
 181             LOCK(cs_KeyStore);
 182             for (MalleableKeyMap::const_iterator mi = mapMalleableKeys.begin(); mi != mapMalleableKeys.end(); mi++)
 183                 malleableViewList.push_back(CMalleableKeyView(mi->first));
 184         }
 185     }
 186 };
 187
 188 typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
 189
 190 /** Keystore which keeps the private keys encrypted.
 191  * It derives from the basic key store, which is used if no encryption is active.
 192  */
 193 class CCryptoKeyStore : public CBasicKeyStore
 194 {
 195 private:
 196     CryptedKeyMap mapCryptedKeys;
 197
 198     CKeyingMaterial vMasterKey;
 199
 200     // if fUseCrypto is true, mapKeys must be empty
 201     // if fUseCrypto is false, vMasterKey must be empty
 202     bool fUseCrypto;
 203
 204 protected:
 205     bool SetCrypted();
 206
 207     // will encrypt previously unencrypted keys
 208     bool EncryptKeys(CKeyingMaterial& vMasterKeyIn);
 209     bool DecryptKeys(const CKeyingMaterial& vMasterKeyIn);
 210
 211     bool Unlock(const CKeyingMaterial& vMasterKeyIn);
 212
 213 public:
 214     CCryptoKeyStore() : fUseCrypto(false) { }
 215
 216     bool IsCrypted() const
 217     {
 218         return fUseCrypto;
 219     }
 220
 221     bool IsLocked() const
 222     {
 223         if (!IsCrypted())
 224             return false;
 225         bool result;
 226         {
 227             LOCK(cs_KeyStore);
 228             result = vMasterKey.empty();
 229         }
 230         return result;
 231     }
 232
 233     bool Lock();
 234
 235     virtual bool AddCryptedKey(const CPubKey &vchPubKey, const std::vector<unsigned char> &vchCryptedSecret);
 236     bool AddKey(const CKey& key);
 237     bool HaveKey(const CKeyID &address) const
 238     {
 239         {
 240             LOCK(cs_KeyStore);
 241             if (!IsCrypted())
 242                 return CBasicKeyStore::HaveKey(address);
 243             return mapCryptedKeys.count(address) > 0;
 244         }
 245     }
 246     bool GetKey(const CKeyID &address, CKey& keyOut) const;
 247     bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
 248     void GetKeys(std::set<CKeyID> &setAddress) const
 249     {
 250         if (!IsCrypted())
 251         {
 252             CBasicKeyStore::GetKeys(setAddress);
 253             return;
 254         }
 255         setAddress.clear();
 256         CryptedKeyMap::const_iterator mi = mapCryptedKeys.begin();
 257         while (mi != mapCryptedKeys.end())
 258         {
 259             setAddress.insert((*mi).first);
 260             mi++;
 261         }
 262     }
 263
 264     /* Wallet status (encrypted, locked) changed.
 265      * Note: Called without locks held.
 266      */
 267     boost::signals2::signal<void (CCryptoKeyStore* wallet)> NotifyStatusChanged;
 268 };
 269
 270 #endif