aboutsummaryrefslogtreecommitdiffstats
path: root/accounts/keystore/keystore_test.go
blob: 5d89a4dbb7f2ddac727cba1830a40fa69a5f195a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library 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.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package keystore

import (
    "io/ioutil"
    "math/rand"
    "os"
    "runtime"
    "sort"
    "strings"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/accounts"
    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/event"
)

var testSigData = make([]byte, 32)

func TestKeyStore(t *testing.T) {
    dir, ks := tmpKeyStore(t, true)
    defer os.RemoveAll(dir)

    a, err := ks.NewAccount("foo")
    if err != nil {
        t.Fatal(err)
    }
    if !strings.HasPrefix(a.URL.Path, dir) {
        t.Errorf("account file %s doesn't have dir prefix", a.URL)
    }
    stat, err := os.Stat(a.URL.Path)
    if err != nil {
        t.Fatalf("account file %s doesn't exist (%v)", a.URL, err)
    }
    if runtime.GOOS != "windows" && stat.Mode() != 0600 {
        t.Fatalf("account file has wrong mode: got %o, want %o", stat.Mode(), 0600)
    }
    if !ks.HasAddress(a.Address) {
        t.Errorf("HasAccount(%x) should've returned true", a.Address)
    }
    if err := ks.Update(a, "foo", "bar"); err != nil {
        t.Errorf("Update error: %v", err)
    }
    if err := ks.Delete(a, "bar"); err != nil {
        t.Errorf("Delete error: %v", err)
    }
    if common.FileExist(a.URL.Path) {
        t.Errorf("account file %s should be gone after Delete", a.URL)
    }
    if ks.HasAddress(a.Address) {
        t.Errorf("HasAccount(%x) should've returned true after Delete", a.Address)
    }
}

func TestSign(t *testing.T) {
    dir, ks := tmpKeyStore(t, true)
    defer os.RemoveAll(dir)

    pass := "" // not used but required by API
    a1, err := ks.NewAccount(pass)
    if err != nil {
        t.Fatal(err)
    }
    if err := ks.Unlock(a1, ""); err != nil {
        t.Fatal(err)
    }
    if _, err := ks.SignHash(accounts.Account{Address: a1.Address}, testSigData); err != nil {
        t.Fatal(err)
    }
}

func TestSignWithPassphrase(t *testing.T) {
    dir, ks := tmpKeyStore(t, true)
    defer os.RemoveAll(dir)

    pass := "passwd"
    acc, err := ks.NewAccount(pass)
    if err != nil {
        t.Fatal(err)
    }

    if _, unlocked := ks.unlocked[acc.Address]; unlocked {
        t.Fatal("expected account to be locked")
    }

    _, err = ks.SignHashWithPassphrase(acc, pass, testSigData)
    if err != nil {
        t.Fatal(err)
    }

    if _, unlocked := ks.unlocked[acc.Address]; unlocked {
        t.Fatal("expected account to be locked")
    }

    if _, err = ks.SignHashWithPassphrase(acc, "invalid passwd", testSigData); err == nil {
        t.Fatal("expected SignHashWithPassphrase to fail with invalid password")
    }
}

func TestTimedUnlock(t *testing.T) {
    dir, ks := tmpKeyStore(t, true)
    defer os.RemoveAll(dir)

    pass := "foo"
    a1, err := ks.NewAccount(pass)
    if err != nil {
        t.Fatal(err)
    }

    // Signing without passphrase fails because account is locked
    _, err = ks.SignHash(accounts.Account{Address: a1.Address}, testSigData)
    if err != ErrLocked {
        t.Fatal("Signing should've failed with ErrLocked before unlocking, got ", err)
    }

    // Signing with passphrase works
    if err = ks.TimedUnlock(a1, pass, 100*time.Millisecond); err != nil {
        t.Fatal(err)
    }

    // Signing without passphrase works because account is temp unlocked
    _, err = ks.SignHash(accounts.Account{Address: a1.Address}, testSigData)
    if err != nil {
        t.Fatal("Signing shouldn't return an error after unlocking, got ", err)
    }

    // Signing fails again after automatic locking
    time.Sleep(250 * time.Millisecond)
    _, err = ks.SignHash(accounts.Account{Address: a1.Address}, testSigData)
    if err != ErrLocked {
        t.Fatal("Signing should've failed with ErrLocked timeout expired, got ", err)
    }
}

func TestOverrideUnlock(t *testing.T) {
    dir, ks := tmpKeyStore(t, false)
    defer os.RemoveAll(dir)

    pass := "foo"
    a1, err := ks.NewAccount(pass)
    if err != nil {
        t.Fatal(err)
    }

    // Unlock indefinitely.
    if err = ks.TimedUnlock(a1, pass, 5*time.Minute); err != nil {
        t.Fatal(err)
    }

    // Signing without passphrase works because account is temp unlocked
    _, err = ks.SignHash(accounts.Account{Address: a1.Address}, testSigData)
    if err != nil {
        t.Fatal("Signing shouldn't return an error after unlocking, got ", err)
    }

    // reset unlock to a shorter period, invalidates the previous unlock
    if err = ks.TimedUnlock(a1, pass, 100*time.Millisecond); err != nil {
        t.Fatal(err)
    }

    // Signing without passphrase still works because account is temp unlocked
    _, err = ks.SignHash(accounts.Account{Address: a1.Address}, testSigData)
    if err != nil {
        t.Fatal("Signing shouldn't return an error after unlocking, got ", err)
    }

    // Signing fails again after automatic locking
    time.Sleep(250 * time.Millisecond)
    _, err = ks.SignHash(accounts.Account{Address: a1.Address}, testSigData)
    if err != ErrLocked {
        t.Fatal("Signing should've failed with ErrLocked timeout expired, got ", err)
    }
}

// This test should fail under -race if signing races the expiration goroutine.
func TestSignRace(t *testing.T) {
    dir, ks := tmpKeyStore(t, false)
    defer os.RemoveAll(dir)

    // Create a test account.
    a1, err := ks.NewAccount("")
    if err != nil {
        t.Fatal("could not create the test account", err)
    }

    if err := ks.TimedUnlock(a1, "", 15*time.Millisecond); err != nil {
        t.Fatal("could not unlock the test account", err)
    }
    end := time.Now().Add(500 * time.Millisecond)
    for time.Now().Before(end) {
        if _, err := ks.SignHash(accounts.Account{Address: a1.Address}, testSigData); err == ErrLocked {
            return
        } else if err != nil {
            t.Errorf("Sign error: %v", err)
            return
        }
        time.Sleep(1 * time.Millisecond)
    }
    t.Errorf("Account did not lock within the timeout")
}

// Tests that the wallet notifier loop starts and stops correctly based on the
// addition and removal of wallet event subscriptions.
func TestWalletNotifierLifecycle(t *testing.T) {
    // Create a temporary kesytore to test with
    dir, ks := tmpKeyStore(t, false)
    defer os.RemoveAll(dir)

    // Ensure that the notification updater is not running yet
    time.Sleep(250 * time.Millisecond)
    ks.mu.RLock()
    updating := ks.updating
    ks.mu.RUnlock()

    if updating {
        t.Errorf("wallet notifier running without subscribers")
    }
    // Subscribe to the wallet feed and ensure the updater boots up
    updates := make(chan accounts.WalletEvent)

    subs := make([]event.Subscription, 2)
    for i := 0; i < len(subs); i++ {
        // Create a new subscription
        subs[i] = ks.Subscribe(updates)

        // Ensure the notifier comes online
        time.Sleep(250 * time.Millisecond)
        ks.mu.RLock()
        updating = ks.updating
        ks.mu.RUnlock()

        if !updating {
            t.Errorf("sub %d: wallet notifier not running after subscription", i)
        }
    }
    // Unsubscribe and ensure the updater terminates eventually
    for i := 0; i < len(subs); i++ {
        // Close an existing subscription
        subs[i].Unsubscribe()

        // Ensure the notifier shuts down at and only at the last close
        for k := 0; k < int(walletRefreshCycle/(250*time.Millisecond))+2; k++ {
            ks.mu.RLock()
            updating = ks.updating
            ks.mu.RUnlock()

            if i < len(subs)-1 && !updating {
                t.Fatalf("sub %d: event notifier stopped prematurely", i)
            }
            if i == len(subs)-1 && !updating {
                return
            }
            time.Sleep(250 * time.Millisecond)
        }
    }
    t.Errorf("wallet notifier didn't terminate after unsubscribe")
}

// Tests that wallet notifications and correctly fired when accounts are added
// or deleted from the keystore.
func TestWalletNotifications(t *testing.T) {
    // Create a temporary kesytore to test with
    dir, ks := tmpKeyStore(t, false)
    defer os.RemoveAll(dir)

    // Subscribe to the wallet feed
    updates := make(chan accounts.WalletEvent, 1)
    sub := ks.Subscribe(updates)
    defer sub.Unsubscribe()

    // Randomly add and remove account and make sure events and wallets are in sync
    live := make(map[common.Address]accounts.Account)
    for i := 0; i < 1024; i++ {
        // Execute a creation or deletion and ensure event arrival
        if create := len(live) == 0 || rand.Int()%4 > 0; create {
            // Add a new account and ensure wallet notifications arrives
            account, err := ks.NewAccount("")
            if err != nil {
                t.Fatalf("failed to create test account: %v", err)
            }
            select {
            case event := <-updates:
                if !event.Arrive {
                    t.Errorf("departure event on account creation")
                }
                if event.Wallet.Accounts()[0] != account {
                    t.Errorf("account mismatch on created wallet: have %v, want %v", event.Wallet.Accounts()[0], account)
                }
            default:
                t.Errorf("wallet arrival event not fired on account creation")
            }
            live[account.Address] = account
        } else {
            // Select a random account to delete (crude, but works)
            var account accounts.Account
            for _, a := range live {
                account = a
                break
            }
            // Remove an account and ensure wallet notifiaction arrives
            if err := ks.Delete(account, ""); err != nil {
                t.Fatalf("failed to delete test account: %v", err)
            }
            select {
            case event := <-updates:
                if event.Arrive {
                    t.Errorf("arrival event on account deletion")
                }
                if event.Wallet.Accounts()[0] != account {
                    t.Errorf("account mismatch on deleted wallet: have %v, want %v", event.Wallet.Accounts()[0], account)
                }
            default:
                t.Errorf("wallet departure event not fired on account creation")
            }
            delete(live, account.Address)
        }
        // Retrieve the list of wallets and ensure it matches with our required live set
        liveList := make([]accounts.Account, 0, len(live))
        for _, account := range live {
            liveList = append(liveList, account)
        }
        sort.Sort(accountsByURL(liveList))

        wallets := ks.Wallets()
        if len(liveList) != len(wallets) {
            t.Errorf("wallet list doesn't match required accounts: have %v, want %v", wallets, liveList)
        } else {
            for j, wallet := range wallets {
                if accs := wallet.Accounts(); len(accs) != 1 {
                    t.Errorf("wallet %d: contains invalid number of accounts: have %d, want 1", j, len(accs))
                } else if accs[0] != liveList[j] {
                    t.Errorf("wallet %d: account mismatch: have %v, want %v", j, accs[0], liveList[j])
                }
            }
        }
    }
}

func tmpKeyStore(t *testing.T, encrypted bool) (string, *KeyStore) {
    d, err := ioutil.TempDir("", "eth-keystore-test")
    if err != nil {
        t.Fatal(err)
    }
    new := NewPlaintextKeyStore
    if encrypted {
        new = func(kd string) *KeyStore { return NewKeyStore(kd, veryLightScryptN, veryLightScryptP) }
    }
    return d, new(d)
}