src/keystore.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2015 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #ifndef BITCOIN_KEYSTORE_H
   7 #define BITCOIN_KEYSTORE_H
   8
   9 #include "key.h"
  10 #include "pubkey.h"
  11 #include "script/script.h"
  12 #include "script/standard.h"
  13 #include "sync.h"
  14
  15 #include <boost/signals2/signal.hpp>
  16
  17 /** A virtual base class for key stores */
  18 class CKeyStore
  19 {
  20 protected:
  21     mutable CCriticalSection cs_KeyStore;
  22
  23 public:
  24     virtual ~CKeyStore() {}
  25
  26     //! Add a key to the store.
  27     virtual bool AddKeyPubKey(const CKey &key, const CPubKey &pubkey) =0;
  28     virtual bool AddKey(const CKey &key);
  29
  30     //! Check whether a key corresponding to a given address is present in the store.
  31     virtual bool HaveKey(const CKeyID &address) const =0;
  32     virtual bool GetKey(const CKeyID &address, CKey& keyOut) const =0;
  33     virtual void GetKeys(std::set<CKeyID> &setAddress) const =0;
  34     virtual bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const =0;
  35
  36     //! Support for BIP 0013 : see https://github.com/bitcoin/bips/blob/master/bip-0013.mediawiki
  37     virtual bool AddCScript(const CScript& redeemScript) =0;
  38     virtual bool HaveCScript(const CScriptID &hash) const =0;
  39     virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const =0;
  40
  41     //! Support for Watch-only addresses
  42     virtual bool AddWatchOnly(const CScript &dest) =0;
  43     virtual bool RemoveWatchOnly(const CScript &dest) =0;
  44     virtual bool HaveWatchOnly(const CScript &dest) const =0;
  45     virtual bool HaveWatchOnly() const =0;
  46 };
  47
  48 typedef std::map<CKeyID, CKey> KeyMap;
  49 typedef std::map<CKeyID, CPubKey> WatchKeyMap;
  50 typedef std::map<CScriptID, CScript > ScriptMap;
  51 typedef std::set<CScript> WatchOnlySet;
  52
  53 /** Basic key store, that keeps keys in an address->secret map */
  54 class CBasicKeyStore : public CKeyStore
  55 {
  56 protected:
  57     KeyMap mapKeys;
  58     WatchKeyMap mapWatchKeys;
  59     ScriptMap mapScripts;
  60     WatchOnlySet setWatchOnly;
  61
  62 public:
  63     bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey) override;
  64     bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
  65     bool HaveKey(const CKeyID &address) const override
  66     {
  67         bool result;
  68         {
  69             LOCK(cs_KeyStore);
  70             result = (mapKeys.count(address) > 0);
  71         }
  72         return result;
  73     }
  74     void GetKeys(std::set<CKeyID> &setAddress) const override
  75     {
  76         setAddress.clear();
  77         {
  78             LOCK(cs_KeyStore);
  79             KeyMap::const_iterator mi = mapKeys.begin();
  80             while (mi != mapKeys.end())
  81             {
  82                 setAddress.insert((*mi).first);
  83                 mi++;
  84             }
  85         }
  86     }
  87     bool GetKey(const CKeyID &address, CKey &keyOut) const override
  88     {
  89         {
  90             LOCK(cs_KeyStore);
  91             KeyMap::const_iterator mi = mapKeys.find(address);
  92             if (mi != mapKeys.end())
  93             {
  94                 keyOut = mi->second;
  95                 return true;
  96             }
  97         }
  98         return false;
  99     }
 100     virtual bool AddCScript(const CScript& redeemScript) override;
 101     virtual bool HaveCScript(const CScriptID &hash) const override;
 102     virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const override;
 103
 104     virtual bool AddWatchOnly(const CScript &dest) override;
 105     virtual bool RemoveWatchOnly(const CScript &dest) override;
 106     virtual bool HaveWatchOnly(const CScript &dest) const override;
 107     virtual bool HaveWatchOnly() const override;
 108 };
 109
 110 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CKeyingMaterial;
 111 typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
 112
 113 #endif // BITCOIN_KEYSTORE_H