5f94f8c7e7
This PR will will break existing UIs, since it changes all calls like ApproveSignTransaction to be on the form ui_approveSignTransaction. This is to make it possible for the UI to reuse the json-rpc library from go-ethereum, which uses this convention. Also, this PR removes some unused structs, after import/export were removed from the external api (so no longer needs internal methods for approval) One more breaking change is introduced, removing passwords from the ApproveSignTxResponse and the likes. This makes the manual interface more like the rulebased interface, and integrates nicely with the credential storage. Thus, the way it worked before, it would be tempting for the UI to implement 'remember password' functionality. The way it is now, it will be easy instead to tell clef to store passwords and use them. If a pw is not found in the credential store, the user is prompted to provide the password.
324 lines
8.7 KiB
Go
324 lines
8.7 KiB
Go
// Copyright 2018 The go-ethereum Authors
|
|
// 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 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 General Public License
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
//
|
|
package core
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"math/big"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/accounts"
|
|
"github.com/ethereum/go-ethereum/accounts/keystore"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/internal/ethapi"
|
|
"github.com/ethereum/go-ethereum/rlp"
|
|
"github.com/ethereum/go-ethereum/signer/storage"
|
|
)
|
|
|
|
//Used for testing
|
|
type headlessUi struct {
|
|
approveCh chan string // to send approve/deny
|
|
inputCh chan string // to send password
|
|
}
|
|
|
|
func (ui *headlessUi) OnInputRequired(info UserInputRequest) (UserInputResponse, error) {
|
|
input := <-ui.inputCh
|
|
return UserInputResponse{Text: input}, nil
|
|
}
|
|
|
|
func (ui *headlessUi) OnSignerStartup(info StartupInfo) {}
|
|
func (ui *headlessUi) RegisterUIServer(api *UIServerAPI) {}
|
|
func (ui *headlessUi) OnApprovedTx(tx ethapi.SignTransactionResult) {}
|
|
|
|
func (ui *headlessUi) ApproveTx(request *SignTxRequest) (SignTxResponse, error) {
|
|
|
|
switch <-ui.approveCh {
|
|
case "Y":
|
|
return SignTxResponse{request.Transaction, true}, nil
|
|
case "M": // modify
|
|
// The headless UI always modifies the transaction
|
|
old := big.Int(request.Transaction.Value)
|
|
newVal := big.NewInt(0).Add(&old, big.NewInt(1))
|
|
request.Transaction.Value = hexutil.Big(*newVal)
|
|
return SignTxResponse{request.Transaction, true}, nil
|
|
default:
|
|
return SignTxResponse{request.Transaction, false}, nil
|
|
}
|
|
}
|
|
|
|
func (ui *headlessUi) ApproveSignData(request *SignDataRequest) (SignDataResponse, error) {
|
|
approved := "Y" == <-ui.approveCh
|
|
return SignDataResponse{approved}, nil
|
|
}
|
|
|
|
func (ui *headlessUi) ApproveListing(request *ListRequest) (ListResponse, error) {
|
|
approval := <-ui.approveCh
|
|
//fmt.Printf("approval %s\n", approval)
|
|
switch approval {
|
|
case "A":
|
|
return ListResponse{request.Accounts}, nil
|
|
case "1":
|
|
l := make([]accounts.Account, 1)
|
|
l[0] = request.Accounts[1]
|
|
return ListResponse{l}, nil
|
|
default:
|
|
return ListResponse{nil}, nil
|
|
}
|
|
}
|
|
|
|
func (ui *headlessUi) ApproveNewAccount(request *NewAccountRequest) (NewAccountResponse, error) {
|
|
if "Y" == <-ui.approveCh {
|
|
return NewAccountResponse{true}, nil
|
|
}
|
|
return NewAccountResponse{false}, nil
|
|
}
|
|
|
|
func (ui *headlessUi) ShowError(message string) {
|
|
//stdout is used by communication
|
|
fmt.Fprintln(os.Stderr, message)
|
|
}
|
|
|
|
func (ui *headlessUi) ShowInfo(message string) {
|
|
//stdout is used by communication
|
|
fmt.Fprintln(os.Stderr, message)
|
|
}
|
|
|
|
func tmpDirName(t *testing.T) string {
|
|
d, err := ioutil.TempDir("", "eth-keystore-test")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
d, err = filepath.EvalSymlinks(d)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
return d
|
|
}
|
|
|
|
func setup(t *testing.T) (*SignerAPI, *headlessUi) {
|
|
db, err := NewAbiDBFromFile("../../cmd/clef/4byte.json")
|
|
if err != nil {
|
|
t.Fatal(err.Error())
|
|
}
|
|
ui := &headlessUi{make(chan string, 20), make(chan string, 20)}
|
|
am := StartClefAccountManager(tmpDirName(t), true, true)
|
|
api := NewSignerAPI(am, 1337, true, ui, db, true, &storage.NoStorage{})
|
|
return api, ui
|
|
|
|
}
|
|
func createAccount(ui *headlessUi, api *SignerAPI, t *testing.T) {
|
|
ui.approveCh <- "Y"
|
|
ui.inputCh <- "a_long_password"
|
|
_, err := api.New(context.Background())
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
// Some time to allow changes to propagate
|
|
time.Sleep(250 * time.Millisecond)
|
|
}
|
|
|
|
func failCreateAccountWithPassword(ui *headlessUi, api *SignerAPI, password string, t *testing.T) {
|
|
|
|
ui.approveCh <- "Y"
|
|
// We will be asked three times to provide a suitable password
|
|
ui.inputCh <- password
|
|
ui.inputCh <- password
|
|
ui.inputCh <- password
|
|
|
|
addr, err := api.New(context.Background())
|
|
if err == nil {
|
|
t.Fatal("Should have returned an error")
|
|
}
|
|
if addr != (common.Address{}) {
|
|
t.Fatal("Empty address should be returned")
|
|
}
|
|
}
|
|
|
|
func failCreateAccount(ui *headlessUi, api *SignerAPI, t *testing.T) {
|
|
ui.approveCh <- "N"
|
|
addr, err := api.New(context.Background())
|
|
if err != ErrRequestDenied {
|
|
t.Fatal(err)
|
|
}
|
|
if addr != (common.Address{}) {
|
|
t.Fatal("Empty address should be returned")
|
|
}
|
|
}
|
|
|
|
func list(ui *headlessUi, api *SignerAPI, t *testing.T) ([]common.Address, error) {
|
|
ui.approveCh <- "A"
|
|
return api.List(context.Background())
|
|
|
|
}
|
|
|
|
func TestNewAcc(t *testing.T) {
|
|
api, control := setup(t)
|
|
verifyNum := func(num int) {
|
|
list, err := list(control, api, t)
|
|
if err != nil {
|
|
t.Errorf("Unexpected error %v", err)
|
|
}
|
|
if len(list) != num {
|
|
t.Errorf("Expected %d accounts, got %d", num, len(list))
|
|
}
|
|
}
|
|
// Testing create and create-deny
|
|
createAccount(control, api, t)
|
|
createAccount(control, api, t)
|
|
failCreateAccount(control, api, t)
|
|
failCreateAccount(control, api, t)
|
|
createAccount(control, api, t)
|
|
failCreateAccount(control, api, t)
|
|
createAccount(control, api, t)
|
|
failCreateAccount(control, api, t)
|
|
verifyNum(4)
|
|
|
|
// Fail to create this, due to bad password
|
|
failCreateAccountWithPassword(control, api, "short", t)
|
|
failCreateAccountWithPassword(control, api, "longerbutbad\rfoo", t)
|
|
verifyNum(4)
|
|
|
|
// Testing listing:
|
|
// Listing one Account
|
|
control.approveCh <- "1"
|
|
list, err := api.List(context.Background())
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if len(list) != 1 {
|
|
t.Fatalf("List should only show one Account")
|
|
}
|
|
// Listing denied
|
|
control.approveCh <- "Nope"
|
|
list, err = api.List(context.Background())
|
|
if len(list) != 0 {
|
|
t.Fatalf("List should be empty")
|
|
}
|
|
if err != ErrRequestDenied {
|
|
t.Fatal("Expected deny")
|
|
}
|
|
}
|
|
|
|
func mkTestTx(from common.MixedcaseAddress) SendTxArgs {
|
|
to := common.NewMixedcaseAddress(common.HexToAddress("0x1337"))
|
|
gas := hexutil.Uint64(21000)
|
|
gasPrice := (hexutil.Big)(*big.NewInt(2000000000))
|
|
value := (hexutil.Big)(*big.NewInt(1e18))
|
|
nonce := (hexutil.Uint64)(0)
|
|
data := hexutil.Bytes(common.Hex2Bytes("01020304050607080a"))
|
|
tx := SendTxArgs{
|
|
From: from,
|
|
To: &to,
|
|
Gas: gas,
|
|
GasPrice: gasPrice,
|
|
Value: value,
|
|
Data: &data,
|
|
Nonce: nonce}
|
|
return tx
|
|
}
|
|
|
|
func TestSignTx(t *testing.T) {
|
|
var (
|
|
list []common.Address
|
|
res, res2 *ethapi.SignTransactionResult
|
|
err error
|
|
)
|
|
|
|
api, control := setup(t)
|
|
createAccount(control, api, t)
|
|
control.approveCh <- "A"
|
|
list, err = api.List(context.Background())
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
a := common.NewMixedcaseAddress(list[0])
|
|
|
|
methodSig := "test(uint)"
|
|
tx := mkTestTx(a)
|
|
|
|
control.approveCh <- "Y"
|
|
control.inputCh <- "wrongpassword"
|
|
res, err = api.SignTransaction(context.Background(), tx, &methodSig)
|
|
if res != nil {
|
|
t.Errorf("Expected nil-response, got %v", res)
|
|
}
|
|
if err != keystore.ErrDecrypt {
|
|
t.Errorf("Expected ErrLocked! %v", err)
|
|
}
|
|
control.approveCh <- "No way"
|
|
res, err = api.SignTransaction(context.Background(), tx, &methodSig)
|
|
if res != nil {
|
|
t.Errorf("Expected nil-response, got %v", res)
|
|
}
|
|
if err != ErrRequestDenied {
|
|
t.Errorf("Expected ErrRequestDenied! %v", err)
|
|
}
|
|
// Sign with correct password
|
|
control.approveCh <- "Y"
|
|
control.inputCh <- "a_long_password"
|
|
res, err = api.SignTransaction(context.Background(), tx, &methodSig)
|
|
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
parsedTx := &types.Transaction{}
|
|
rlp.Decode(bytes.NewReader(res.Raw), parsedTx)
|
|
|
|
//The tx should NOT be modified by the UI
|
|
if parsedTx.Value().Cmp(tx.Value.ToInt()) != 0 {
|
|
t.Errorf("Expected value to be unchanged, expected %v got %v", tx.Value, parsedTx.Value())
|
|
}
|
|
control.approveCh <- "Y"
|
|
control.inputCh <- "a_long_password"
|
|
|
|
res2, err = api.SignTransaction(context.Background(), tx, &methodSig)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !bytes.Equal(res.Raw, res2.Raw) {
|
|
t.Error("Expected tx to be unmodified by UI")
|
|
}
|
|
|
|
//The tx is modified by the UI
|
|
control.approveCh <- "M"
|
|
control.inputCh <- "a_long_password"
|
|
|
|
res2, err = api.SignTransaction(context.Background(), tx, &methodSig)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
parsedTx2 := &types.Transaction{}
|
|
rlp.Decode(bytes.NewReader(res.Raw), parsedTx2)
|
|
|
|
//The tx should be modified by the UI
|
|
if parsedTx2.Value().Cmp(tx.Value.ToInt()) != 0 {
|
|
t.Errorf("Expected value to be unchanged, got %v", parsedTx.Value())
|
|
}
|
|
if bytes.Equal(res.Raw, res2.Raw) {
|
|
t.Error("Expected tx to be modified by UI")
|
|
}
|
|
|
|
}
|