src/keystore.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2017 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 std::set<CKeyID> GetKeys() 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 std::set<CScriptID> GetCScripts() const =0;
  40     virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const =0;
  41
  42     //! Support for Watch-only addresses
  43     virtual bool AddWatchOnly(const CScript &dest) =0;
  44     virtual bool RemoveWatchOnly(const CScript &dest) =0;
  45     virtual bool HaveWatchOnly(const CScript &dest) const =0;
  46     virtual bool HaveWatchOnly() const =0;
  47 };
  48
  49 typedef std::map<CKeyID, CKey> KeyMap;
  50 typedef std::map<CKeyID, CPubKey> WatchKeyMap;
  51 typedef std::map<CScriptID, CScript > ScriptMap;
  52 typedef std::set<CScript> WatchOnlySet;
  53
  54 /** Basic key store, that keeps keys in an address->secret map */
  55 class CBasicKeyStore : public CKeyStore
  56 {
  57 protected:
  58     KeyMap mapKeys;
  59     WatchKeyMap mapWatchKeys;
  60     ScriptMap mapScripts;
  61     WatchOnlySet setWatchOnly;
  62
  63 public:
  64     bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey) override;
  65     bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
  66     bool HaveKey(const CKeyID &address) const override;
  67     std::set<CKeyID> GetKeys() const override;
  68     bool GetKey(const CKeyID &address, CKey &keyOut) const override;
  69     bool AddCScript(const CScript& redeemScript) override;
  70     bool HaveCScript(const CScriptID &hash) const override;
  71     std::set<CScriptID> GetCScripts() const override;
  72     bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const override;
  73
  74     bool AddWatchOnly(const CScript &dest) override;
  75     bool RemoveWatchOnly(const CScript &dest) override;
  76     bool HaveWatchOnly(const CScript &dest) const override;
  77     bool HaveWatchOnly() const override;
  78 };
  79
  80 typedef std::vector<unsigned char, secure_allocator<unsigned char> > CKeyingMaterial;
  81 typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
  82
  83 #endif // BITCOIN_KEYSTORE_H