Bitcoin Core  27.99.0
P2P Digital Currency
signingprovider.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2022 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_SCRIPT_SIGNINGPROVIDER_H
7 #define BITCOIN_SCRIPT_SIGNINGPROVIDER_H
8 
9 #include <addresstype.h>
10 #include <attributes.h>
11 #include <key.h>
12 #include <pubkey.h>
13 #include <script/keyorigin.h>
14 #include <script/script.h>
15 #include <sync.h>
16 
18 {
19  bool operator()(const std::vector<unsigned char>& a, const std::vector<unsigned char>& b) const
20  {
21  if (a.size() < b.size()) return true;
22  if (a.size() > b.size()) return false;
23  return a < b;
24  }
25 };
26 
28 {
39  std::map<std::pair<std::vector<unsigned char>, int>, std::set<std::vector<unsigned char>, ShortestVectorFirstComparator>> scripts;
41  void Merge(TaprootSpendData other);
42 };
43 
46 {
47 private:
49  struct LeafInfo
50  {
51  std::vector<unsigned char> script;
53  std::vector<uint256> merkle_branch;
54  };
55 
57  struct NodeInfo
58  {
63  std::vector<LeafInfo> leaves;
64  };
66  bool m_valid = true;
67 
103  std::vector<std::optional<NodeInfo>> m_branch;
104 
107  bool m_parity;
108 
110  static NodeInfo Combine(NodeInfo&& a, NodeInfo&& b);
112  void Insert(NodeInfo&& node, int depth);
113 
114 public:
118  TaprootBuilder& Add(int depth, Span<const unsigned char> script, int leaf_version, bool track = true);
120  TaprootBuilder& AddOmitted(int depth, const uint256& hash);
123  TaprootBuilder& Finalize(const XOnlyPubKey& internal_key);
124 
126  bool IsValid() const { return m_valid; }
128  bool IsComplete() const { return m_valid && (m_branch.size() == 0 || (m_branch.size() == 1 && m_branch[0].has_value())); }
132  static bool ValidDepths(const std::vector<int>& depths);
136  std::vector<std::tuple<uint8_t, uint8_t, std::vector<unsigned char>>> GetTreeTuples() const;
138  bool HasScripts() const { return !m_branch.empty(); }
139 };
140 
147 std::optional<std::vector<std::tuple<int, std::vector<unsigned char>, int>>> InferTaprootTree(const TaprootSpendData& spenddata, const XOnlyPubKey& output);
148 
151 {
152 public:
153  virtual ~SigningProvider() {}
154  virtual bool GetCScript(const CScriptID &scriptid, CScript& script) const { return false; }
155  virtual bool HaveCScript(const CScriptID &scriptid) const { return false; }
156  virtual bool GetPubKey(const CKeyID &address, CPubKey& pubkey) const { return false; }
157  virtual bool GetKey(const CKeyID &address, CKey& key) const { return false; }
158  virtual bool HaveKey(const CKeyID &address) const { return false; }
159  virtual bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const { return false; }
160  virtual bool GetTaprootSpendData(const XOnlyPubKey& output_key, TaprootSpendData& spenddata) const { return false; }
161  virtual bool GetTaprootBuilder(const XOnlyPubKey& output_key, TaprootBuilder& builder) const { return false; }
162 
163  bool GetKeyByXOnly(const XOnlyPubKey& pubkey, CKey& key) const
164  {
165  for (const auto& id : pubkey.GetKeyIDs()) {
166  if (GetKey(id, key)) return true;
167  }
168  return false;
169  }
170 
171  bool GetPubKeyByXOnly(const XOnlyPubKey& pubkey, CPubKey& out) const
172  {
173  for (const auto& id : pubkey.GetKeyIDs()) {
174  if (GetPubKey(id, out)) return true;
175  }
176  return false;
177  }
178 
179  bool GetKeyOriginByXOnly(const XOnlyPubKey& pubkey, KeyOriginInfo& info) const
180  {
181  for (const auto& id : pubkey.GetKeyIDs()) {
182  if (GetKeyOrigin(id, info)) return true;
183  }
184  return false;
185  }
186 };
187 
189 
191 {
192 private:
193  const bool m_hide_secret;
194  const bool m_hide_origin;
196 
197 public:
198  HidingSigningProvider(const SigningProvider* provider, bool hide_secret, bool hide_origin) : m_hide_secret(hide_secret), m_hide_origin(hide_origin), m_provider(provider) {}
199  bool GetCScript(const CScriptID& scriptid, CScript& script) const override;
200  bool GetPubKey(const CKeyID& keyid, CPubKey& pubkey) const override;
201  bool GetKey(const CKeyID& keyid, CKey& key) const override;
202  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
203  bool GetTaprootSpendData(const XOnlyPubKey& output_key, TaprootSpendData& spenddata) const override;
204  bool GetTaprootBuilder(const XOnlyPubKey& output_key, TaprootBuilder& builder) const override;
205 };
206 
208 {
209  std::map<CScriptID, CScript> scripts;
210  std::map<CKeyID, CPubKey> pubkeys;
211  std::map<CKeyID, std::pair<CPubKey, KeyOriginInfo>> origins;
212  std::map<CKeyID, CKey> keys;
213  std::map<XOnlyPubKey, TaprootBuilder> tr_trees;
215  bool GetCScript(const CScriptID& scriptid, CScript& script) const override;
216  bool GetPubKey(const CKeyID& keyid, CPubKey& pubkey) const override;
217  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
218  bool GetKey(const CKeyID& keyid, CKey& key) const override;
219  bool GetTaprootSpendData(const XOnlyPubKey& output_key, TaprootSpendData& spenddata) const override;
220  bool GetTaprootBuilder(const XOnlyPubKey& output_key, TaprootBuilder& builder) const override;
221 
223 };
224 
227 {
228 protected:
229  using KeyMap = std::map<CKeyID, CKey>;
230  using ScriptMap = std::map<CScriptID, CScript>;
231 
238 
280 
282 
283 public:
285 
286  virtual bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey);
287  virtual bool AddKey(const CKey &key) { return AddKeyPubKey(key, key.GetPubKey()); }
288  virtual bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const override;
289  virtual bool HaveKey(const CKeyID &address) const override;
290  virtual std::set<CKeyID> GetKeys() const;
291  virtual bool GetKey(const CKeyID &address, CKey &keyOut) const override;
292  virtual bool AddCScript(const CScript& redeemScript);
293  virtual bool HaveCScript(const CScriptID &hash) const override;
294  virtual std::set<CScriptID> GetCScripts() const;
295  virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const override;
296 };
297 
299 CKeyID GetKeyForDestination(const SigningProvider& store, const CTxDestination& dest);
300 
303  std::vector<std::unique_ptr<SigningProvider>> m_providers;
304 
305 public:
306  void AddProvider(std::unique_ptr<SigningProvider> provider);
307 
308  bool GetCScript(const CScriptID& scriptid, CScript& script) const override;
309  bool GetPubKey(const CKeyID& keyid, CPubKey& pubkey) const override;
310  bool GetKeyOrigin(const CKeyID& keyid, KeyOriginInfo& info) const override;
311  bool GetKey(const CKeyID& keyid, CKey& key) const override;
312  bool GetTaprootSpendData(const XOnlyPubKey& output_key, TaprootSpendData& spenddata) const override;
313  bool GetTaprootBuilder(const XOnlyPubKey& output_key, TaprootBuilder& builder) const override;
314 };
315 
316 #endif // BITCOIN_SCRIPT_SIGNINGPROVIDER_H
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
Definition: addresstype.h:131
#define LIFETIMEBOUND
Definition: attributes.h:16
An encapsulated private key.
Definition: key.h:33
CPubKey GetPubKey() const
Compute the public key from a private key.
Definition: key.cpp:182
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:24
An encapsulated public key.
Definition: pubkey.h:34
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:414
A reference to a CScript: the Hash160 of its serialization.
Definition: script.h:583
Fillable signing provider that keeps keys in an address->secret map.
virtual bool AddKeyPubKey(const CKey &key, const CPubKey &pubkey)
virtual bool GetPubKey(const CKeyID &address, CPubKey &vchPubKeyOut) const override
virtual bool GetCScript(const CScriptID &hash, CScript &redeemScriptOut) const override
virtual bool GetKey(const CKeyID &address, CKey &keyOut) const override
virtual bool AddCScript(const CScript &redeemScript)
std::map< CScriptID, CScript > ScriptMap
KeyMap mapKeys GUARDED_BY(cs_KeyStore)
Map of key id to unencrypted private keys known by the signing provider.
ScriptMap mapScripts GUARDED_BY(cs_KeyStore)
Map of script id to scripts known by the signing provider.
void ImplicitlyLearnRelatedKeyScripts(const CPubKey &pubkey) EXCLUSIVE_LOCKS_REQUIRED(cs_KeyStore)
virtual std::set< CKeyID > GetKeys() const
std::map< CKeyID, CKey > KeyMap
virtual std::set< CScriptID > GetCScripts() const
virtual bool HaveCScript(const CScriptID &hash) const override
virtual bool AddKey(const CKey &key)
RecursiveMutex cs_KeyStore
virtual bool HaveKey(const CKeyID &address) const override
bool GetTaprootSpendData(const XOnlyPubKey &output_key, TaprootSpendData &spenddata) const override
bool GetKey(const CKeyID &keyid, CKey &key) const override
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
const SigningProvider * m_provider
bool GetPubKey(const CKeyID &keyid, CPubKey &pubkey) const override
HidingSigningProvider(const SigningProvider *provider, bool hide_secret, bool hide_origin)
bool GetTaprootBuilder(const XOnlyPubKey &output_key, TaprootBuilder &builder) const override
bool GetCScript(const CScriptID &scriptid, CScript &script) const override
A signing provider to be used to interface with multiple signing providers at once.
bool GetKey(const CKeyID &keyid, CKey &key) const override
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
bool GetTaprootSpendData(const XOnlyPubKey &output_key, TaprootSpendData &spenddata) const override
std::vector< std::unique_ptr< SigningProvider > > m_providers
bool GetPubKey(const CKeyID &keyid, CPubKey &pubkey) const override
bool GetTaprootBuilder(const XOnlyPubKey &output_key, TaprootBuilder &builder) const override
void AddProvider(std::unique_ptr< SigningProvider > provider)
bool GetCScript(const CScriptID &scriptid, CScript &script) const override
An interface to be implemented by keystores that support signing.
virtual ~SigningProvider()
virtual bool HaveKey(const CKeyID &address) const
virtual bool GetCScript(const CScriptID &scriptid, CScript &script) const
virtual bool GetTaprootSpendData(const XOnlyPubKey &output_key, TaprootSpendData &spenddata) const
virtual bool HaveCScript(const CScriptID &scriptid) const
bool GetKeyByXOnly(const XOnlyPubKey &pubkey, CKey &key) const
virtual bool GetPubKey(const CKeyID &address, CPubKey &pubkey) const
bool GetKeyOriginByXOnly(const XOnlyPubKey &pubkey, KeyOriginInfo &info) const
virtual bool GetTaprootBuilder(const XOnlyPubKey &output_key, TaprootBuilder &builder) const
virtual bool GetKey(const CKeyID &address, CKey &key) const
virtual bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const
bool GetPubKeyByXOnly(const XOnlyPubKey &pubkey, CPubKey &out) const
Utility class to construct Taproot outputs from internal key and script tree.
WitnessV1Taproot GetOutput()
Compute scriptPubKey (after Finalize()).
static NodeInfo Combine(NodeInfo &&a, NodeInfo &&b)
Combine information about a parent Merkle tree node from its child nodes.
TaprootSpendData GetSpendData() const
Compute spending data (after Finalize()).
bool IsComplete() const
Return whether there were either no leaves, or the leaves form a Huffman tree.
bool HasScripts() const
Returns true if there are any tapscripts.
static bool ValidDepths(const std::vector< int > &depths)
Check if a list of depths is legal (will lead to IsComplete()).
void Insert(NodeInfo &&node, int depth)
Insert information about a node at a certain depth, and propagate information up.
XOnlyPubKey m_internal_key
The internal key, set when finalizing.
XOnlyPubKey m_output_key
The output key, computed when finalizing.
bool IsValid() const
Return true if so far all input was valid.
TaprootBuilder & Add(int depth, Span< const unsigned char > script, int leaf_version, bool track=true)
Add a new script at a certain depth in the tree.
std::vector< std::optional< NodeInfo > > m_branch
The current state of the builder.
TaprootBuilder & AddOmitted(int depth, const uint256 &hash)
Like Add(), but for a Merkle node with a given hash to the tree.
TaprootBuilder & Finalize(const XOnlyPubKey &internal_key)
Finalize the construction.
bool m_parity
The tweak parity, computed when finalizing.
std::vector< std::tuple< uint8_t, uint8_t, std::vector< unsigned char > > > GetTreeTuples() const
Returns a vector of tuples representing the depth, leaf version, and script.
bool m_valid
Whether the builder is in a valid state so far.
std::vector< CKeyID > GetKeyIDs() const
Returns a list of CKeyIDs for the CPubKeys that could have been used to create this XOnlyPubKey.
Definition: pubkey.cpp:202
256-bit opaque blob.
Definition: uint256.h:106
Definition: init.h:25
const SigningProvider & DUMMY_SIGNING_PROVIDER
std::optional< std::vector< std::tuple< int, std::vector< unsigned char >, int > > > InferTaprootTree(const TaprootSpendData &spenddata, const XOnlyPubKey &output)
Given a TaprootSpendData and the output key, reconstruct its script tree.
CKeyID GetKeyForDestination(const SigningProvider &store, const CTxDestination &dest)
Return the CKeyID of the key involved in a script (if there is a unique one).
bool GetPubKey(const CKeyID &keyid, CPubKey &pubkey) const override
FlatSigningProvider & Merge(FlatSigningProvider &&b) LIFETIMEBOUND
std::map< CKeyID, std::pair< CPubKey, KeyOriginInfo > > origins
bool GetTaprootBuilder(const XOnlyPubKey &output_key, TaprootBuilder &builder) const override
bool GetKey(const CKeyID &keyid, CKey &key) const override
std::map< CKeyID, CPubKey > pubkeys
std::map< CKeyID, CKey > keys
bool GetKeyOrigin(const CKeyID &keyid, KeyOriginInfo &info) const override
std::map< CScriptID, CScript > scripts
std::map< XOnlyPubKey, TaprootBuilder > tr_trees
bool GetCScript(const CScriptID &scriptid, CScript &script) const override
Map from output key to Taproot tree (which can then make the TaprootSpendData.
bool GetTaprootSpendData(const XOnlyPubKey &output_key, TaprootSpendData &spenddata) const override
bool operator()(const std::vector< unsigned char > &a, const std::vector< unsigned char > &b) const
Information about a tracked leaf in the Merkle tree.
std::vector< uint256 > merkle_branch
The hashing partners above this leaf.
int leaf_version
The leaf version for that script.
std::vector< unsigned char > script
The script.
Information associated with a node in the Merkle tree.
uint256 hash
Merkle hash of this node.
std::vector< LeafInfo > leaves
Tracked leaves underneath this node (either from the node itself, or its children).
uint256 merkle_root
The Merkle root of the script tree (0 if no scripts).
std::map< std::pair< std::vector< unsigned char >, int >, std::set< std::vector< unsigned char >, ShortestVectorFirstComparator > > scripts
Map from (script, leaf_version) to (sets of) control blocks.
void Merge(TaprootSpendData other)
Merge other TaprootSpendData (for the same scriptPubKey) into this.
XOnlyPubKey internal_key
The BIP341 internal key.
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49