2015-01-24 17:07:20 -08:00
|
|
|
/*
|
|
|
|
This file is part of go-ethereum
|
|
|
|
|
|
|
|
go-ethereum is free software: you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
go-ethereum is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
|
|
along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* @authors
|
|
|
|
* Gustav Simonsson <gustav.simonsson@gmail.com>
|
|
|
|
* @date 2015
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
/*
|
|
|
|
|
|
|
|
This abstracts part of a user's interaction with an account she controls.
|
|
|
|
It's not an abstraction of core Ethereum accounts data type / logic -
|
|
|
|
for that see the core processing code of blocks / txs.
|
|
|
|
|
|
|
|
Currently this is pretty much a passthrough to the KeyStore2 interface,
|
|
|
|
and accounts persistence is derived from stored keys' addresses
|
|
|
|
|
|
|
|
*/
|
|
|
|
package accounts
|
|
|
|
|
|
|
|
import (
|
2015-03-09 15:02:43 -07:00
|
|
|
"bytes"
|
2015-03-07 15:35:23 -08:00
|
|
|
"crypto/ecdsa"
|
2015-01-24 17:07:20 -08:00
|
|
|
crand "crypto/rand"
|
2015-02-25 08:29:23 -08:00
|
|
|
"errors"
|
2015-03-25 08:45:56 -07:00
|
|
|
"os"
|
2015-02-25 08:29:23 -08:00
|
|
|
"sync"
|
|
|
|
"time"
|
2015-02-26 02:16:01 -08:00
|
|
|
|
2015-01-24 17:07:20 -08:00
|
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
|
|
)
|
|
|
|
|
2015-03-07 03:38:33 -08:00
|
|
|
var (
|
|
|
|
ErrLocked = errors.New("account is locked")
|
|
|
|
ErrNoKeys = errors.New("no keys in store")
|
|
|
|
)
|
2015-02-25 08:29:23 -08:00
|
|
|
|
2015-01-27 20:12:57 -08:00
|
|
|
type Account struct {
|
|
|
|
Address []byte
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
type Manager struct {
|
2015-03-09 16:09:39 -07:00
|
|
|
keyStore crypto.KeyStore2
|
|
|
|
unlocked map[string]*unlocked
|
|
|
|
mutex sync.RWMutex
|
2015-03-07 16:27:30 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
type unlocked struct {
|
|
|
|
*crypto.Key
|
2015-03-07 17:45:02 -08:00
|
|
|
abort chan struct{}
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
|
|
|
|
2015-03-09 16:09:39 -07:00
|
|
|
func NewManager(keyStore crypto.KeyStore2) *Manager {
|
2015-03-07 16:52:49 -08:00
|
|
|
return &Manager{
|
2015-03-09 16:09:39 -07:00
|
|
|
keyStore: keyStore,
|
|
|
|
unlocked: make(map[string]*unlocked),
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-03-09 15:02:43 -07:00
|
|
|
func (am *Manager) HasAccount(addr []byte) bool {
|
|
|
|
accounts, _ := am.Accounts()
|
|
|
|
for _, acct := range accounts {
|
|
|
|
if bytes.Compare(acct.Address, addr) == 0 {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2015-03-07 03:38:33 -08:00
|
|
|
// Coinbase returns the account address that mining rewards are sent to.
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) Coinbase() (addr []byte, err error) {
|
2015-03-07 03:38:33 -08:00
|
|
|
// TODO: persist coinbase address on disk
|
|
|
|
return am.firstAddr()
|
|
|
|
}
|
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) firstAddr() ([]byte, error) {
|
2015-03-07 03:38:33 -08:00
|
|
|
addrs, err := am.keyStore.GetKeyAddresses()
|
2015-03-10 07:41:08 -07:00
|
|
|
if os.IsNotExist(err) {
|
|
|
|
return nil, ErrNoKeys
|
|
|
|
} else if err != nil {
|
2015-03-07 03:38:33 -08:00
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if len(addrs) == 0 {
|
|
|
|
return nil, ErrNoKeys
|
|
|
|
}
|
|
|
|
return addrs[0], nil
|
|
|
|
}
|
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) DeleteAccount(address []byte, auth string) error {
|
2015-02-24 09:03:10 -08:00
|
|
|
return am.keyStore.DeleteKey(address, auth)
|
|
|
|
}
|
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) Sign(a Account, toSign []byte) (signature []byte, err error) {
|
2015-02-25 09:40:59 -08:00
|
|
|
am.mutex.RLock()
|
2015-03-07 16:27:30 -08:00
|
|
|
unlockedKey, found := am.unlocked[string(a.Address)]
|
2015-02-25 09:40:59 -08:00
|
|
|
am.mutex.RUnlock()
|
2015-03-07 16:27:30 -08:00
|
|
|
if !found {
|
2015-02-25 08:29:23 -08:00
|
|
|
return nil, ErrLocked
|
|
|
|
}
|
|
|
|
signature, err = crypto.Sign(toSign, unlockedKey.PrivateKey)
|
|
|
|
return signature, err
|
|
|
|
}
|
|
|
|
|
2015-03-09 16:09:39 -07:00
|
|
|
// TimedUnlock unlocks the account with the given address.
|
|
|
|
// When timeout has passed, the account will be locked again.
|
|
|
|
func (am *Manager) TimedUnlock(addr []byte, keyAuth string, timeout time.Duration) error {
|
2015-03-25 08:45:56 -07:00
|
|
|
key, err := am.keyStore.GetKey(addr, keyAuth)
|
2015-01-24 17:07:20 -08:00
|
|
|
if err != nil {
|
2015-03-09 16:09:39 -07:00
|
|
|
return err
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
2015-03-09 16:09:39 -07:00
|
|
|
u := am.addUnlocked(addr, key)
|
|
|
|
go am.dropLater(addr, u, timeout)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Unlock unlocks the account with the given address. The account
|
|
|
|
// stays unlocked until the program exits or until a TimedUnlock
|
|
|
|
// timeout (started after the call to Unlock) expires.
|
|
|
|
func (am *Manager) Unlock(addr []byte, keyAuth string) error {
|
2015-03-25 08:45:56 -07:00
|
|
|
key, err := am.keyStore.GetKey(addr, keyAuth)
|
2015-03-09 16:09:39 -07:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
am.addUnlocked(addr, key)
|
|
|
|
return nil
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) NewAccount(auth string) (Account, error) {
|
2015-01-24 17:07:20 -08:00
|
|
|
key, err := am.keyStore.GenerateNewKey(crand.Reader, auth)
|
|
|
|
if err != nil {
|
2015-03-07 15:18:13 -08:00
|
|
|
return Account{}, err
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
2015-03-07 15:18:13 -08:00
|
|
|
return Account{Address: key.Address}, nil
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) Accounts() ([]Account, error) {
|
2015-01-24 17:07:20 -08:00
|
|
|
addresses, err := am.keyStore.GetKeyAddresses()
|
2015-03-10 07:41:08 -07:00
|
|
|
if os.IsNotExist(err) {
|
|
|
|
return nil, ErrNoKeys
|
|
|
|
} else if err != nil {
|
2015-01-24 17:07:20 -08:00
|
|
|
return nil, err
|
|
|
|
}
|
2015-01-27 20:12:57 -08:00
|
|
|
accounts := make([]Account, len(addresses))
|
2015-01-24 17:07:20 -08:00
|
|
|
for i, addr := range addresses {
|
2015-01-27 20:12:57 -08:00
|
|
|
accounts[i] = Account{
|
|
|
|
Address: addr,
|
2015-01-24 17:07:20 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return accounts, err
|
|
|
|
}
|
2015-02-25 08:29:23 -08:00
|
|
|
|
2015-03-07 16:52:49 -08:00
|
|
|
func (am *Manager) addUnlocked(addr []byte, key *crypto.Key) *unlocked {
|
2015-03-07 17:45:02 -08:00
|
|
|
u := &unlocked{Key: key, abort: make(chan struct{})}
|
2015-03-07 15:36:06 -08:00
|
|
|
am.mutex.Lock()
|
2015-03-07 16:27:30 -08:00
|
|
|
prev, found := am.unlocked[string(addr)]
|
|
|
|
if found {
|
|
|
|
// terminate dropLater for this key to avoid unexpected drops.
|
|
|
|
close(prev.abort)
|
2015-03-09 16:09:39 -07:00
|
|
|
// the key is zeroed here instead of in dropLater because
|
|
|
|
// there might not actually be a dropLater running for this
|
|
|
|
// key, i.e. when Unlock was used.
|
2015-03-07 16:27:30 -08:00
|
|
|
zeroKey(prev.PrivateKey)
|
|
|
|
}
|
|
|
|
am.unlocked[string(addr)] = u
|
2015-03-07 15:36:06 -08:00
|
|
|
am.mutex.Unlock()
|
2015-03-07 16:27:30 -08:00
|
|
|
return u
|
2015-03-07 15:36:06 -08:00
|
|
|
}
|
|
|
|
|
2015-03-09 16:09:39 -07:00
|
|
|
func (am *Manager) dropLater(addr []byte, u *unlocked, timeout time.Duration) {
|
|
|
|
t := time.NewTimer(timeout)
|
2015-03-07 16:27:30 -08:00
|
|
|
defer t.Stop()
|
|
|
|
select {
|
|
|
|
case <-u.abort:
|
|
|
|
// just quit
|
|
|
|
case <-t.C:
|
|
|
|
am.mutex.Lock()
|
2015-03-07 17:45:02 -08:00
|
|
|
// only drop if it's still the same key instance that dropLater
|
|
|
|
// was launched with. we can check that using pointer equality
|
|
|
|
// because the map stores a new pointer every time the key is
|
|
|
|
// unlocked.
|
|
|
|
if am.unlocked[string(addr)] == u {
|
2015-03-07 16:27:30 -08:00
|
|
|
zeroKey(u.PrivateKey)
|
2015-03-07 17:45:02 -08:00
|
|
|
delete(am.unlocked, string(addr))
|
2015-03-07 16:27:30 -08:00
|
|
|
}
|
|
|
|
am.mutex.Unlock()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// zeroKey zeroes a private key in memory.
|
|
|
|
func zeroKey(k *ecdsa.PrivateKey) {
|
|
|
|
b := k.D.Bits()
|
|
|
|
for i := range b {
|
|
|
|
b[i] = 0
|
|
|
|
}
|
2015-02-25 08:29:23 -08:00
|
|
|
}
|
2015-03-23 06:00:06 -07:00
|
|
|
|
2015-03-26 11:55:39 -07:00
|
|
|
// USE WITH CAUTION = this will save an unencrypted private key on disk
|
|
|
|
// no cli or js interface
|
2015-03-23 06:00:06 -07:00
|
|
|
func (am *Manager) Export(path string, addr []byte, keyAuth string) error {
|
|
|
|
key, err := am.keyStore.GetKey(addr, keyAuth)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return crypto.SaveECDSA(path, key.PrivateKey)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (am *Manager) Import(path string, keyAuth string) (Account, error) {
|
|
|
|
privateKeyECDSA, err := crypto.LoadECDSA(path)
|
|
|
|
if err != nil {
|
|
|
|
return Account{}, err
|
|
|
|
}
|
|
|
|
key := crypto.NewKeyFromECDSA(privateKeyECDSA)
|
|
|
|
if err = am.keyStore.StoreKey(key, keyAuth); err != nil {
|
|
|
|
return Account{}, err
|
|
|
|
}
|
|
|
|
return Account{Address: key.Address}, nil
|
|
|
|
}
|
2015-03-24 09:19:11 -07:00
|
|
|
|
|
|
|
func (am *Manager) ImportPreSaleKey(keyJSON []byte, password string) (acc Account, err error) {
|
|
|
|
var key *crypto.Key
|
|
|
|
key, err = crypto.ImportPreSaleKey(am.keyStore, keyJSON, password)
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
if err = am.keyStore.StoreKey(key, password); err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
return Account{Address: key.Address}, nil
|
|
|
|
}
|