This repository has been archived by the owner on May 25, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
speculos_test.go
419 lines (371 loc) · 9.65 KB
/
speculos_test.go
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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
//go:build speculos
// +build speculos
package ledger
import (
"bufio"
"bytes"
"context"
"encoding/hex"
"encoding/json"
"fmt"
"net/http"
"strings"
"sync"
"testing"
"time"
)
// Speculos event description struct
type speculosEvent struct {
text string
skip bool
action func() error
}
// Speculos object struct
type speculos struct {
Info HidDeviceInfo
step int
events []speculosEvent
done bool
ready *sync.Cond
}
// Create new Speculos object
func newSpeculos() *speculos {
return &speculos{
step: -1,
done: false,
ready: sync.NewCond(&sync.Mutex{}),
}
}
// Open dummy method for Speculos
func (device *speculos) Open() error {
return nil
}
// Close dummy method for Speculos
func (device *speculos) Close() {
}
// GetInfo dummy method for Speculos
func (device *speculos) GetInfo() *HidDeviceInfo {
return &device.Info
}
// Processing Speculos events
func (device *speculos) onEvent(data map[string]interface{}) bool {
textField, ok := data["text"]
if !ok {
panic("No 'text' field")
}
text, ok := textField.(string)
if !ok {
panic("'text' field in not string")
}
if device.step == -1 {
for i := 0; i < len(device.events); i++ {
if device.events[i].text == text {
if device.events[i].skip {
return true
}
device.step = i
break
}
}
if device.step == -1 {
panic("Unexpected event " + text)
}
}
event := &device.events[device.step]
if text != event.text {
panic("Unexpected event " + text)
}
if event.action != nil {
event.action()
}
device.step++
return device.step < len(device.events)
}
// HTTP Post method implementation for sending data to Speculos
func post(url string, data string) (map[string]interface{}, error) {
resp, err := http.Post(url, "application/json", bytes.NewBuffer([]byte(data)))
if err != nil {
return nil, err
}
var res map[string]interface{}
json.NewDecoder(resp.Body).Decode(&res)
resp.Body.Close()
return res, nil
}
// Send APDU packet to Speculos
func sendApdu(apdu string) (string, error) {
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
req, _ := http.NewRequest(http.MethodPost, "http://127.0.0.1:5001/apdu", bytes.NewBuffer([]byte("{\"data\": \""+apdu+"\"}")))
req.Header.Set("Content-Type", "application/json")
req = req.WithContext(ctx)
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
return "", err
}
defer resp.Body.Close()
var res map[string]interface{}
json.NewDecoder(resp.Body).Decode(&res)
data, ok := res["data"].(string)
if !ok {
return "", fmt.Errorf("Wrong response")
}
return data, nil
}
// Emulate of press left button on Ledger
func pressLeft() error {
_, err := post("http://127.0.0.1:5001/button/left", "{\"action\":\"press-and-release\"}")
return err
}
// Emulate of press both buttons on Ledger
func pressBoth() error {
_, err := post("http://127.0.0.1:5001/button/both", "{\"action\":\"press-and-release\"}")
return err
}
// Emulate of press right button on Ledger
func pressRight() error {
_, err := post("http://127.0.0.1:5001/button/right", "{\"action\":\"press-and-release\"}")
return err
}
// Exchange APDU packets with Speculos
func (device *speculos) Exchange(apdu []byte) ([]byte, error) {
hexData, err := sendApdu(hex.EncodeToString(apdu))
if err != nil {
return nil, err
}
data, err := hex.DecodeString(hexData)
if err != nil {
return nil, err
}
return data, nil
}
// Prepare the device for testing and start the Speculoos event pump.
func (device *speculos) setupTest(ctx context.Context, events []speculosEvent) {
device.step = -1
device.events = events
device.done = false
go func() {
// defer t.Logf("Speculos events pump done!\n")
defer device.ready.Signal()
// t.Logf("Speculos events pump start!\n")
req, _ := http.NewRequest(http.MethodGet, "http://127.0.0.1:5001/events?stream=true", nil)
req = req.WithContext(ctx)
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
device.done = false
device.ready.Signal()
return
}
defer resp.Body.Close()
reader := bufio.NewReader(resp.Body)
for {
line, err := reader.ReadBytes('\n')
if err != nil {
device.done = false
device.ready.Signal()
return
}
text := string(line)
// t.Logf("Line: %v\n", text)
if strings.HasPrefix(text, "data: ") {
end := strings.LastIndexByte(text, '}')
if end == -1 {
panic("Wrong event")
}
var event map[string]interface{}
json.Unmarshal(line[6:end+1], &event)
if !device.onEvent(event) {
// t.Logf("Speculos events pump DONE!\n")
device.done = true
device.ready.Signal()
return
}
}
}
}()
}
// Wait for a test to complete
func (device *speculos) waitTestDone() bool {
device.ready.L.Lock()
device.ready.Wait()
device.ready.L.Unlock()
return device.done
}
// Run tests on Speculos emilator
func doSpeculosTests(t *testing.T) bool {
ctx, cancel := context.WithTimeout(context.Background(), 180*time.Second)
defer cancel()
ok := true
speculos := newSpeculos()
device := NewLedger(speculos)
path := StringToPath("44'/540'/0'/0/0'")
// run GetExtendedPublicKey test
speculos.setupTest(ctx, []speculosEvent{
{text: "Spacemesh", skip: true},
{text: "is ready", skip: true},
{text: "Export public key"},
{text: "m/44'/540'/0'/0/0", action: pressBoth},
{text: "Confirm export"},
{text: "public key?", action: pressRight},
{text: "Spacemesh"},
{text: "is ready"},
})
publicKey, err := device.GetExtendedPublicKey(path)
if err != nil {
ok = false
t.Logf("get public key ERROR: %v\n", err)
} else {
key := hex.EncodeToString(publicKey.PublicKey)
t.Logf("public key: %v\n", key)
if key != "a47a88814cecde42f2ad0d75123cf530fbe8e5940bbc44273014714df9a33e16" {
ok = false
t.Logf("WRONG public key\n")
} else {
t.Logf("Get public key: OK\n")
}
}
ok = ok && speculos.waitTestDone()
if !ok {
return false
}
// run GetAddress test
speculos.setupTest(ctx, []speculosEvent{
{text: "Spacemesh", skip: true},
{text: "is ready", skip: true},
{text: "Export address"},
{text: "Path: m/44'/540'/", action: pressBoth},
{text: "Confirm"},
{text: "export address?", action: pressRight},
{text: "Spacemesh"},
{text: "is ready"},
})
address, err := device.GetAddress(path)
if err != nil {
ok = false
t.Logf("get address ERROR: %v\n", err)
} else {
addressStr := hex.EncodeToString(address)
t.Logf("address: %v\n", addressStr)
if addressStr != "a47a88814cecde42f2ad0d75123cf530fbe8e594" {
ok = false
t.Logf("WRONG address\n")
} else {
t.Logf("Get address: OK\n")
}
}
ok = ok && speculos.waitTestDone()
if !ok {
return false
}
// run ShowAddress test
speculos.setupTest(ctx, []speculosEvent{
{text: "Spacemesh", skip: true},
{text: "is ready", skip: true},
{text: "Verify address"},
{text: "Make sure it agre", action: pressBoth},
{text: "Address path"},
{text: "m/44'/540'/0'/0/0", action: pressBoth},
{text: "Address"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Spacemesh"},
{text: "is ready"},
})
err = device.ShowAddress(path)
if err != nil {
ok = false
t.Logf("Show address ERROR: %v\n", err)
} else {
t.Logf("Show address: OK\n")
}
ok = ok && speculos.waitTestDone()
if !ok {
return false
}
// run Sign coin transaction test
speculos.setupTest(ctx, []speculosEvent{
{text: "Spacemesh", skip: true},
{text: "is ready", skip: true},
{text: "Tx type:"},
{text: "COIN ED", action: pressBoth},
{text: "Send SMH"},
{text: "1.0", action: pressBoth},
{text: "To address"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Max Tx Fee"},
{text: "0.001", action: pressBoth},
{text: "Confirm"},
{text: "transaction?", action: pressRight},
{text: "Signer"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Sign using"},
{text: "this signer?", action: pressRight},
{text: "Spacemesh"},
{text: "is ready"},
})
ok = testTx(t, device, "coin.tx.json", "coin", publicKey.PublicKey, nil)
ok = ok && speculos.waitTestDone()
if !ok {
return false
}
// run Sign app transaction test
speculos.setupTest(ctx, []speculosEvent{
{text: "Spacemesh", skip: true},
{text: "is ready", skip: true},
{text: "Tx type:"},
{text: "EXEC APP ED", action: pressBoth},
{text: "Send SMH"},
{text: "1.0", action: pressBoth},
{text: "To address"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Max Tx Fee"},
{text: "0.001", action: pressBoth},
{text: "Confirm"},
{text: "transaction?", action: pressRight},
{text: "Signer"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Sign using"},
{text: "this signer?", action: pressRight},
{text: "Spacemesh"},
{text: "is ready"},
})
ok = testTx(t, device, "app.tx.json", "app", publicKey.PublicKey, nil)
ok = ok && speculos.waitTestDone()
if !ok {
return false
}
// run Sign spawn transaction test
speculos.setupTest(ctx, []speculosEvent{
{text: "Spacemesh", skip: true},
{text: "is ready", skip: true},
{text: "Tx type:"},
{text: "SPAWN APP ED", action: pressBoth},
{text: "Send SMH"},
{text: "1.0", action: pressBoth},
{text: "To address"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Max Tx Fee"},
{text: "0.001", action: pressBoth},
{text: "Confirm"},
{text: "transaction?", action: pressRight},
{text: "Signer"},
{text: "a47a88814cecde42f", action: pressBoth},
{text: "Sign using"},
{text: "this signer?", action: pressRight},
{text: "Spacemesh"},
{text: "is ready"},
})
ok = testTx(t, device, "spawn.tx.json", "spawn", publicKey.PublicKey, nil)
ok = ok && speculos.waitTestDone()
if !ok {
return false
}
return ok
}
// Main Speculos test route
func TestSpeculos(t *testing.T) {
if !doSpeculosTests(t) {
t.FailNow()
}
}