|
|
|
|
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
|
|
|
// Copyright (c) 2009-2014 The Bitcoin Core developers
|
|
|
|
|
// Distributed under the MIT software license, see the accompanying
|
|
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
|
|
|
|
|
|
#ifndef BITCOIN_KEYSTORE_H
|
|
|
|
|
#define BITCOIN_KEYSTORE_H
|
|
|
|
|
|
|
|
|
|
#include "key.h"
|
|
|
|
|
#include "pubkey.h"
|
|
|
|
|
#include "script/script.h"
|
|
|
|
|
#include "script/standard.h"
|
|
|
|
|
#include "sync.h"
|
|
|
|
|
|
|
|
|
|
#include <boost/signals2/signal.hpp>
|
|
|
|
|
#include <boost/variant.hpp>
|
|
|
|
|
|
|
|
|
|
/** A virtual base class for key stores */
|
CWallet class
* A new class CKeyStore manages private keys, and script.cpp depends on access to CKeyStore.
* A new class CWallet extends CKeyStore, and contains all former wallet-specific globals; CWallet depends on script.cpp, not the other way around.
* Wallet-specific functions in CTransaction/CTxIn/CTxOut (GetDebit, GetCredit, GetChange, IsMine, IsFromMe), are moved to CWallet, taking their former 'this' argument as an explicit parameter
* CWalletTx objects know which CWallet they belong to, for convenience, so they have their own direct (and caching) GetDebit/... functions.
* Some code was moved from CWalletDB to CWallet, such as handling of reserve keys.
* Main.cpp keeps a set of all 'registered' wallets, which should be informed about updates to the block chain, and does not have any notion about any 'main' wallet. Function in main.cpp that require a wallet (such as GenerateCoins), take an explicit CWallet* argument.
* The actual CWallet instance used by the application is defined in init.cpp as "CWallet* pwalletMain". rpc.cpp and ui.cpp use this variable.
* Functions in main.cpp and db.cpp that are not used by other modules are marked static.
* The code for handling the 'submitorder' message is removed, as it not really compatible with the idea that a node is independent from the wallet(s) connected to it, and obsolete anyway.
14 years ago
|
|
|
class CKeyStore
|
|
|
|
|
{
|
|
|
|
|
protected:
|
|
|
|
|
mutable CCriticalSection cs_KeyStore;
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
virtual ~CKeyStore() {}
|
|
|
|
|
|
|
|
|
|
//! Add a key to the store.
|
|
|
|
|
virtual bool AddKeyPubKey(const CKey &key, const CPubKey &pubkey) =0;
|
|
|
|
|
virtual bool AddKey(const CKey &key);
|
|
|
|
|
|
|
|
|
|
//! Check whether a key corresponding to a given address is present in the store.
|
|
|
|
|
virtual bool HaveKey(const CKeyID &address) const =0;
|
|
|
|
|
virtual bool GetKey(const CKeyID &address, CKey& keyOut) const =0;
|
|
|
|
|
virtual void GetKeys(std::set<CKeyID> &setAddress) const =0;
|
|
|
|
|
virtual bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const =0;
|
|
|
|
|
|
|
|
|
|
//! Support for BIP 0013 : see https://github.com/bitcoin/bips/blob/master/bip-0013.mediawiki
|
|
|
|
|
virtual bool AddCScript(const CScript& redeemScript) =0;
|
|
|
|
|
virtual bool HaveCScript(const CScriptID &hash) const =0;
|
|
|
|
|
virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const =0;
|
|
|
|
|
|
|
|
|
|
//! Support for Watch-only addresses
|
|
|
|
|
virtual bool AddWatchOnly(const CScript &dest) =0;
|
|
|
|
|
virtual bool RemoveWatchOnly(const CScript &dest) =0;
|
|
|
|
|
virtual bool HaveWatchOnly(const CScript &dest) const =0;
|
|
|
|
|
virtual bool HaveWatchOnly() const =0;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef std::map<CKeyID, CKey> KeyMap;
|
|
|
|
|
typedef std::map<CKeyID, CPubKey> WatchKeyMap;
|
|
|
|
|
typedef std::map<CScriptID, CScript > ScriptMap;
|
|
|
|
|
typedef std::set<CScript> WatchOnlySet;
|
Add wallet privkey encryption.
This commit adds support for ckeys, or enCrypted private keys, to the wallet.
All keys are stored in memory in their encrypted form and thus the passphrase
is required from the user to spend coins, or to create new addresses.
Keys are encrypted with AES-256-CBC using OpenSSL's EVP library. The key is
calculated via EVP_BytesToKey using SHA512 with (by default) 25000 rounds and
a random salt.
By default, the user's wallet remains unencrypted until they call the RPC
command encryptwallet <passphrase> or, from the GUI menu, Options->
Encrypt Wallet.
When the user is attempting to call RPC functions which require the password
to unlock the wallet, an error will be returned unless they call
walletpassphrase <passphrase> <time to keep key in memory> first.
A keypoolrefill command has been added which tops up the users keypool
(requiring the passphrase via walletpassphrase first).
keypoolsize has been added to the output of getinfo to show the user the
number of keys left before they need to specify their passphrase (and call
keypoolrefill).
Note that walletpassphrase will automatically fill keypool in a separate
thread which it spawns when the passphrase is set. This could cause some
delays in other threads waiting for locks on the wallet passphrase, including
one which could cause the passphrase to be stored longer than expected,
however it will not allow the passphrase to be used longer than expected as
ThreadCleanWalletPassphrase will attempt to get a lock on the key as soon
as the specified lock time has arrived.
When the keypool runs out (and wallet is locked) GetOrReuseKeyFromPool
returns vchDefaultKey, meaning miners may start to generate many blocks to
vchDefaultKey instead of a new key each time.
A walletpassphrasechange <oldpassphrase> <newpassphrase> has been added to
allow the user to change their password via RPC.
Whenever keying material (unencrypted private keys, the user's passphrase,
the wallet's AES key) is stored unencrypted in memory, any reasonable attempt
is made to mlock/VirtualLock that memory before storing the keying material.
This is not true in several (commented) cases where mlock/VirtualLocking the
memory is not possible.
Although encryption of private keys in memory can be very useful on desktop
systems (as some small amount of protection against stupid viruses), on an
RPC server, the password is entered fairly insecurely. Thus, the only main
advantage encryption has for RPC servers is for RPC servers that do not spend
coins, except in rare cases, eg. a webserver of a merchant which only receives
payment except for cases of manual intervention.
Thanks to jgarzik for the original patch and sipa, gmaxwell and many others
for all their input.
Conflicts:
src/wallet.cpp
14 years ago
|
|
|
|
|
|
|
|
/** Basic key store, that keeps keys in an address->secret map */
|
|
|
|
|
class CBasicKeyStore : public CKeyStore
|
|
|
|
|
{
|
|
|
|
|
protected:
|
Add wallet privkey encryption.
This commit adds support for ckeys, or enCrypted private keys, to the wallet.
All keys are stored in memory in their encrypted form and thus the passphrase
is required from the user to spend coins, or to create new addresses.
Keys are encrypted with AES-256-CBC using OpenSSL's EVP library. The key is
calculated via EVP_BytesToKey using SHA512 with (by default) 25000 rounds and
a random salt.
By default, the user's wallet remains unencrypted until they call the RPC
command encryptwallet <passphrase> or, from the GUI menu, Options->
Encrypt Wallet.
When the user is attempting to call RPC functions which require the password
to unlock the wallet, an error will be returned unless they call
walletpassphrase <passphrase> <time to keep key in memory> first.
A keypoolrefill command has been added which tops up the users keypool
(requiring the passphrase via walletpassphrase first).
keypoolsize has been added to the output of getinfo to show the user the
number of keys left before they need to specify their passphrase (and call
keypoolrefill).
Note that walletpassphrase will automatically fill keypool in a separate
thread which it spawns when the passphrase is set. This could cause some
delays in other threads waiting for locks on the wallet passphrase, including
one which could cause the passphrase to be stored longer than expected,
however it will not allow the passphrase to be used longer than expected as
ThreadCleanWalletPassphrase will attempt to get a lock on the key as soon
as the specified lock time has arrived.
When the keypool runs out (and wallet is locked) GetOrReuseKeyFromPool
returns vchDefaultKey, meaning miners may start to generate many blocks to
vchDefaultKey instead of a new key each time.
A walletpassphrasechange <oldpassphrase> <newpassphrase> has been added to
allow the user to change their password via RPC.
Whenever keying material (unencrypted private keys, the user's passphrase,
the wallet's AES key) is stored unencrypted in memory, any reasonable attempt
is made to mlock/VirtualLock that memory before storing the keying material.
This is not true in several (commented) cases where mlock/VirtualLocking the
memory is not possible.
Although encryption of private keys in memory can be very useful on desktop
systems (as some small amount of protection against stupid viruses), on an
RPC server, the password is entered fairly insecurely. Thus, the only main
advantage encryption has for RPC servers is for RPC servers that do not spend
coins, except in rare cases, eg. a webserver of a merchant which only receives
payment except for cases of manual intervention.
Thanks to jgarzik for the original patch and sipa, gmaxwell and many others
for all their input.
Conflicts:
src/wallet.cpp
14 years ago
|
|
|
KeyMap mapKeys;
|
|
|
|
|
WatchKeyMap mapWatchKeys;
|
|
|
|
|
ScriptMap mapScripts;
|
|
|
|
|
WatchOnlySet setWatchOnly;
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
bool AddKeyPubKey(const CKey& key, const CPubKey &pubkey);
|
|
|
|
|
bool GetPubKey(const CKeyID &address, CPubKey& vchPubKeyOut) const;
|
|
|
|
|
bool HaveKey(const CKeyID &address) const
|
CWallet class
* A new class CKeyStore manages private keys, and script.cpp depends on access to CKeyStore.
* A new class CWallet extends CKeyStore, and contains all former wallet-specific globals; CWallet depends on script.cpp, not the other way around.
* Wallet-specific functions in CTransaction/CTxIn/CTxOut (GetDebit, GetCredit, GetChange, IsMine, IsFromMe), are moved to CWallet, taking their former 'this' argument as an explicit parameter
* CWalletTx objects know which CWallet they belong to, for convenience, so they have their own direct (and caching) GetDebit/... functions.
* Some code was moved from CWalletDB to CWallet, such as handling of reserve keys.
* Main.cpp keeps a set of all 'registered' wallets, which should be informed about updates to the block chain, and does not have any notion about any 'main' wallet. Function in main.cpp that require a wallet (such as GenerateCoins), take an explicit CWallet* argument.
* The actual CWallet instance used by the application is defined in init.cpp as "CWallet* pwalletMain". rpc.cpp and ui.cpp use this variable.
* Functions in main.cpp and db.cpp that are not used by other modules are marked static.
* The code for handling the 'submitorder' message is removed, as it not really compatible with the idea that a node is independent from the wallet(s) connected to it, and obsolete anyway.
14 years ago
|
|
|
{
|
|
|
|
|
bool result;
|
|
|
|
|
{
|
|
|
|
|
LOCK(cs_KeyStore);
|
|
|
|
|
result = (mapKeys.count(address) > 0);
|
|
|
|
|
}
|
|
|
|
|
return result;
|
CWallet class
* A new class CKeyStore manages private keys, and script.cpp depends on access to CKeyStore.
* A new class CWallet extends CKeyStore, and contains all former wallet-specific globals; CWallet depends on script.cpp, not the other way around.
* Wallet-specific functions in CTransaction/CTxIn/CTxOut (GetDebit, GetCredit, GetChange, IsMine, IsFromMe), are moved to CWallet, taking their former 'this' argument as an explicit parameter
* CWalletTx objects know which CWallet they belong to, for convenience, so they have their own direct (and caching) GetDebit/... functions.
* Some code was moved from CWalletDB to CWallet, such as handling of reserve keys.
* Main.cpp keeps a set of all 'registered' wallets, which should be informed about updates to the block chain, and does not have any notion about any 'main' wallet. Function in main.cpp that require a wallet (such as GenerateCoins), take an explicit CWallet* argument.
* The actual CWallet instance used by the application is defined in init.cpp as "CWallet* pwalletMain". rpc.cpp and ui.cpp use this variable.
* Functions in main.cpp and db.cpp that are not used by other modules are marked static.
* The code for handling the 'submitorder' message is removed, as it not really compatible with the idea that a node is independent from the wallet(s) connected to it, and obsolete anyway.
14 years ago
|
|
|
}
|
|
|
|
|
void GetKeys(std::set<CKeyID> &setAddress) const
|
|
|
|
|
{
|
|
|
|
|
setAddress.clear();
|
|
|
|
|
{
|
|
|
|
|
LOCK(cs_KeyStore);
|
|
|
|
|
KeyMap::const_iterator mi = mapKeys.begin();
|
|
|
|
|
while (mi != mapKeys.end())
|
|
|
|
|
{
|
|
|
|
|
setAddress.insert((*mi).first);
|
|
|
|
|
mi++;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
bool GetKey(const CKeyID &address, CKey &keyOut) const
|
CWallet class
* A new class CKeyStore manages private keys, and script.cpp depends on access to CKeyStore.
* A new class CWallet extends CKeyStore, and contains all former wallet-specific globals; CWallet depends on script.cpp, not the other way around.
* Wallet-specific functions in CTransaction/CTxIn/CTxOut (GetDebit, GetCredit, GetChange, IsMine, IsFromMe), are moved to CWallet, taking their former 'this' argument as an explicit parameter
* CWalletTx objects know which CWallet they belong to, for convenience, so they have their own direct (and caching) GetDebit/... functions.
* Some code was moved from CWalletDB to CWallet, such as handling of reserve keys.
* Main.cpp keeps a set of all 'registered' wallets, which should be informed about updates to the block chain, and does not have any notion about any 'main' wallet. Function in main.cpp that require a wallet (such as GenerateCoins), take an explicit CWallet* argument.
* The actual CWallet instance used by the application is defined in init.cpp as "CWallet* pwalletMain". rpc.cpp and ui.cpp use this variable.
* Functions in main.cpp and db.cpp that are not used by other modules are marked static.
* The code for handling the 'submitorder' message is removed, as it not really compatible with the idea that a node is independent from the wallet(s) connected to it, and obsolete anyway.
14 years ago
|
|
|
{
|
|
|
|
|
{
|
|
|
|
|
LOCK(cs_KeyStore);
|
|
|
|
|
KeyMap::const_iterator mi = mapKeys.find(address);
|
|
|
|
|
if (mi != mapKeys.end())
|
|
|
|
|
{
|
|
|
|
|
keyOut = mi->second;
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return false;
|
CWallet class
* A new class CKeyStore manages private keys, and script.cpp depends on access to CKeyStore.
* A new class CWallet extends CKeyStore, and contains all former wallet-specific globals; CWallet depends on script.cpp, not the other way around.
* Wallet-specific functions in CTransaction/CTxIn/CTxOut (GetDebit, GetCredit, GetChange, IsMine, IsFromMe), are moved to CWallet, taking their former 'this' argument as an explicit parameter
* CWalletTx objects know which CWallet they belong to, for convenience, so they have their own direct (and caching) GetDebit/... functions.
* Some code was moved from CWalletDB to CWallet, such as handling of reserve keys.
* Main.cpp keeps a set of all 'registered' wallets, which should be informed about updates to the block chain, and does not have any notion about any 'main' wallet. Function in main.cpp that require a wallet (such as GenerateCoins), take an explicit CWallet* argument.
* The actual CWallet instance used by the application is defined in init.cpp as "CWallet* pwalletMain". rpc.cpp and ui.cpp use this variable.
* Functions in main.cpp and db.cpp that are not used by other modules are marked static.
* The code for handling the 'submitorder' message is removed, as it not really compatible with the idea that a node is independent from the wallet(s) connected to it, and obsolete anyway.
14 years ago
|
|
|
}
|
|
|
|
|
virtual bool AddCScript(const CScript& redeemScript);
|
|
|
|
|
virtual bool HaveCScript(const CScriptID &hash) const;
|
|
|
|
|
virtual bool GetCScript(const CScriptID &hash, CScript& redeemScriptOut) const;
|
|
|
|
|
|
|
|
|
|
virtual bool AddWatchOnly(const CScript &dest);
|
|
|
|
|
virtual bool RemoveWatchOnly(const CScript &dest);
|
|
|
|
|
virtual bool HaveWatchOnly(const CScript &dest) const;
|
|
|
|
|
virtual bool HaveWatchOnly() const;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef std::vector<unsigned char, secure_allocator<unsigned char> > CKeyingMaterial;
|
|
|
|
|
typedef std::map<CKeyID, std::pair<CPubKey, std::vector<unsigned char> > > CryptedKeyMap;
|
|
|
|
|
|
|
|
|
|
#endif // BITCOIN_KEYSTORE_H
|
