Additive plumbing for storing a BIP39 entropy alongside the HD seed, mirroring how the seed itself is handled through both key store layers: a plaintext member on CBasicKeyStore, an encrypted pair on CCryptoKeyStore, encryption during the unencrypted-to-encrypted conversion in EncryptKeys with the plaintext cleared, and decryption on unlock. RawHDSeed and CKeyingMaterial are the same secure_allocator vector type, so the entropy passes through EncryptSecret/DecryptSecret with no adaptation. Nothing calls this yet; there is no behaviour change. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
260 lines
7.7 KiB
C++
260 lines
7.7 KiB
C++
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-2014 The Bitcoin Core developers
|
|
// Copyright (c) 2016-2024 The Hush developers
|
|
// Distributed under the GPLv3 software license, see the accompanying
|
|
// file COPYING or https://www.gnu.org/licenses/gpl-3.0.en.html
|
|
|
|
/******************************************************************************
|
|
* Copyright © 2014-2019 The SuperNET Developers. *
|
|
* *
|
|
* See the AUTHORS, DEVELOPER-AGREEMENT and LICENSE files at *
|
|
* the top-level directory of this distribution for the individual copyright *
|
|
* holder information and the developer policies on copyright and licensing. *
|
|
* *
|
|
* Unless otherwise agreed in a custom licensing agreement, no part of the *
|
|
* SuperNET software, including this file may be copied, modified, propagated *
|
|
* or distributed except according to the terms contained in the LICENSE file *
|
|
* *
|
|
* Removal or modification of this copyright notice is prohibited. *
|
|
* *
|
|
******************************************************************************/
|
|
|
|
#include "keystore.h"
|
|
|
|
#include "key.h"
|
|
#include "util.h"
|
|
|
|
#include <boost/foreach.hpp>
|
|
|
|
bool CKeyStore::GetPubKey(const CKeyID &address, CPubKey &vchPubKeyOut) const
|
|
{
|
|
CKey key;
|
|
if (!GetKey(address, key))
|
|
return false;
|
|
vchPubKeyOut = key.GetPubKey();
|
|
return true;
|
|
}
|
|
|
|
bool CKeyStore::AddKey(const CKey &key) {
|
|
return AddKeyPubKey(key, key.GetPubKey());
|
|
}
|
|
|
|
bool CBasicKeyStore::SetHDSeed(const HDSeed& seed)
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
if (!hdSeed.IsNull()) {
|
|
// Don't allow an existing seed to be changed. We can maybe relax this
|
|
// restriction later once we have worked out the UX implications.
|
|
return false;
|
|
}
|
|
hdSeed = seed;
|
|
return true;
|
|
}
|
|
|
|
bool CBasicKeyStore::HaveHDSeed() const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
return !hdSeed.IsNull();
|
|
}
|
|
|
|
bool CBasicKeyStore::GetHDSeed(HDSeed& seedOut) const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
if (hdSeed.IsNull()) {
|
|
return false;
|
|
} else {
|
|
seedOut = hdSeed;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
bool CBasicKeyStore::SetMnemonicEntropy(const RawHDSeed& entropy)
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
if (entropy.empty()) {
|
|
// Never "install" nothing: HaveMnemonicEntropy() would stay false while
|
|
// the caller was told the call succeeded.
|
|
return false;
|
|
}
|
|
if (!mnemonicEntropy.empty()) {
|
|
// Same refuse-to-replace rule as SetHDSeed above, for a sharper reason:
|
|
// this is the printable form of the seed. If it could be swapped while
|
|
// hdSeed stayed put, the wallet would print a seed phrase that does not
|
|
// restore it -- strictly worse than printing none.
|
|
return false;
|
|
}
|
|
mnemonicEntropy = entropy;
|
|
return true;
|
|
}
|
|
|
|
bool CBasicKeyStore::HaveMnemonicEntropy() const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
return !mnemonicEntropy.empty();
|
|
}
|
|
|
|
bool CBasicKeyStore::GetMnemonicEntropy(RawHDSeed& entropyOut) const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
if (mnemonicEntropy.empty()) {
|
|
return false;
|
|
} else {
|
|
entropyOut = mnemonicEntropy;
|
|
return true;
|
|
}
|
|
}
|
|
|
|
bool CBasicKeyStore::AddKeyPubKey(const CKey& key, const CPubKey &pubkey)
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
mapKeys[pubkey.GetID()] = key;
|
|
return true;
|
|
}
|
|
|
|
bool CBasicKeyStore::AddCScript(const CScript& redeemScript)
|
|
{
|
|
if (redeemScript.size() > MAX_SCRIPT_ELEMENT_SIZE)
|
|
return error("CBasicKeyStore::AddCScript(): redeemScripts > %i bytes are invalid", MAX_SCRIPT_ELEMENT_SIZE);
|
|
|
|
LOCK(cs_KeyStore);
|
|
mapScripts[CScriptID(redeemScript)] = redeemScript;
|
|
return true;
|
|
}
|
|
|
|
bool CBasicKeyStore::HaveCScript(const CScriptID& hash) const
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
return mapScripts.count(hash) > 0;
|
|
}
|
|
|
|
bool CBasicKeyStore::GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
ScriptMap::const_iterator mi = mapScripts.find(hash);
|
|
if (mi != mapScripts.end())
|
|
{
|
|
redeemScriptOut = (*mi).second;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool CBasicKeyStore::AddWatchOnly(const CScript &dest)
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
setWatchOnly.insert(dest);
|
|
return true;
|
|
}
|
|
|
|
bool CBasicKeyStore::RemoveWatchOnly(const CScript &dest)
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
setWatchOnly.erase(dest);
|
|
return true;
|
|
}
|
|
|
|
bool CBasicKeyStore::HaveWatchOnly(const CScript &dest) const
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
return setWatchOnly.count(dest) > 0;
|
|
}
|
|
|
|
bool CBasicKeyStore::HaveWatchOnly() const
|
|
{
|
|
LOCK(cs_KeyStore);
|
|
return (!setWatchOnly.empty());
|
|
}
|
|
|
|
//! Sapling
|
|
bool CBasicKeyStore::AddSaplingSpendingKey(
|
|
const libzcash::SaplingExtendedSpendingKey &sk,
|
|
const libzcash::SaplingPaymentAddress &defaultAddr)
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
auto fvk = sk.expsk.full_viewing_key();
|
|
|
|
// if SaplingFullViewingKey is not in SaplingFullViewingKeyMap, add it
|
|
if (!AddSaplingFullViewingKey(fvk, defaultAddr)) {
|
|
return false;
|
|
}
|
|
|
|
mapSaplingSpendingKeys[fvk] = sk;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool CBasicKeyStore::AddSaplingFullViewingKey(
|
|
const libzcash::SaplingFullViewingKey &fvk,
|
|
const libzcash::SaplingPaymentAddress &defaultAddr)
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
auto ivk = fvk.in_viewing_key();
|
|
mapSaplingFullViewingKeys[ivk] = fvk;
|
|
|
|
return CBasicKeyStore::AddSaplingIncomingViewingKey(ivk, defaultAddr);
|
|
}
|
|
|
|
// This function updates the wallet's internal address->ivk map.
|
|
// If we add an address that is already in the map, the map will
|
|
// remain unchanged as each address only has one ivk.
|
|
bool CBasicKeyStore::AddSaplingIncomingViewingKey(
|
|
const libzcash::SaplingIncomingViewingKey &ivk,
|
|
const libzcash::SaplingPaymentAddress &addr)
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
|
|
// Add addr -> SaplingIncomingViewing to SaplingIncomingViewingKeyMap
|
|
mapSaplingIncomingViewingKeys[addr] = ivk;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
|
|
bool CBasicKeyStore::HaveSaplingFullViewingKey(const libzcash::SaplingIncomingViewingKey &ivk) const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
return mapSaplingFullViewingKeys.count(ivk) > 0;
|
|
}
|
|
|
|
bool CBasicKeyStore::HaveSaplingIncomingViewingKey(const libzcash::SaplingPaymentAddress &addr) const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
return mapSaplingIncomingViewingKeys.count(addr) > 0;
|
|
}
|
|
|
|
bool CBasicKeyStore::GetSaplingFullViewingKey(const libzcash::SaplingIncomingViewingKey &ivk,
|
|
libzcash::SaplingFullViewingKey &fvkOut) const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
SaplingFullViewingKeyMap::const_iterator mi = mapSaplingFullViewingKeys.find(ivk);
|
|
if (mi != mapSaplingFullViewingKeys.end()) {
|
|
fvkOut = mi->second;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool CBasicKeyStore::GetSaplingIncomingViewingKey(const libzcash::SaplingPaymentAddress &addr,
|
|
libzcash::SaplingIncomingViewingKey &ivkOut) const
|
|
{
|
|
LOCK(cs_SpendingKeyStore);
|
|
SaplingIncomingViewingKeyMap::const_iterator mi = mapSaplingIncomingViewingKeys.find(addr);
|
|
if (mi != mapSaplingIncomingViewingKeys.end()) {
|
|
ivkOut = mi->second;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool CBasicKeyStore::GetSaplingExtendedSpendingKey(const libzcash::SaplingPaymentAddress &addr,
|
|
libzcash::SaplingExtendedSpendingKey &extskOut) const {
|
|
libzcash::SaplingIncomingViewingKey ivk;
|
|
libzcash::SaplingFullViewingKey fvk;
|
|
|
|
return GetSaplingIncomingViewingKey(addr, ivk) &&
|
|
GetSaplingFullViewingKey(ivk, fvk) &&
|
|
GetSaplingSpendingKey(fvk, extskOut);
|
|
}
|